Returns a resource representation of a collection of replicas created on backup servers connected to Veeam Backup Enterprise Manager. For details, see /replicas.
To get a list of replicas, send the GET HTTP request to the query with the type parameter set to Replica.
The request contains the following headers:
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.
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.
In the query, you can use the following parameters for filtering and sorting.
UID of the VM replica resource, for example: urn:veeam:Replica:58c917c7-7b7a-41ff-8676-226656c35c05.
Name of the replica resource, for example: DNS Replication.
UID of the replication job parent to the replica, for example:urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512.
Name of the replication job parent to the replica, for example: DNS Replication.
UID of the backup repository in which replica metadata is stored, for example: urn:veeam:Repository:b609c947-dd30-4295-8b57-cc880329dbd6.
Name of the backup repository in which replica metadata is stored, for example: Backup Vol 1.
The server returns the following response to the client.
A successfully completed operation returns response code 200 OK.
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
The length of the response body.
The media type and syntax of the request body message. Possible values:
In the response body, the REST API returns a representation of the /replicas resource collection.
The example below returns an entity resource representation of a collection of replicas whose metadata is stored in the Backup Repository 1 backup repository.
GET https://localhost:9398/api/query?type=Replica&format=Entities&filter=RepositoryName=="Backup Repository 1"