This is an archive version of the document. To get the most up-to-date information, see the current version.GET /query?type=Replica
Returns a resource representation of a collection of replicas created on backup servers connected to Veeam Backup Enterprise Manager. For details, see /replicas.
Request
To get a list of replicas, send the GET HTTP request to the query with the type parameter set to Replica.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=Replica |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
Parameter | Type | Description |
|---|---|---|
UID | UidType | UID of the VM replica resource, for example: urn:veeam:Replica:58c917c7-7b7a-41ff-8676-226656c35c05. |
Name | String | Name of the replica resource, for example: DNS Replication. |
JobUid | UidType | UID of the replication job parent to the replica, for example:urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512. |
JobName | String | Name of the replication job parent to the replica, for example: DNS Replication. |
RepositoryUid | UidType | UID of the backup repository in which replica metadata is stored, for example: urn:veeam:Repository:b609c947-dd30-4295-8b57-cc880329dbd6. |
RepositoryName | Name | Name of the backup repository in which replica metadata is stored, for example: Backup Vol 1. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, the REST API returns a representation of the /replicas resource collection.
Example
The example below returns an entity resource representation of a collection of replicas whose metadata is stored in the Backup Repository 1 backup repository.
Request: GET https://localhost:9398/api/query?type=Replica&format=Entities&filter=RepositoryName=="Backup Repository 1"
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |