This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Replication Resources Allocated to Company on Specific Site
You can get a collection resource representation of all cloud replication resources allocated to a company on a site with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of all cloud replication resources allocated to a company on a specific site, send the GET HTTP request to the URL of the /organizations/companies/{companyUid}/sites/{siteUid}/replicationResources collection.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/sites/{siteUid}/replicationResources |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
companyUid | Path | String (uuid) | Yes | — | Company UID |
siteUid | Path | String (uuid) | Yes | — | Site UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
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: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the CompanySiteReplicationResource schema.
Example 
The following request returns a representation of a replication resource allocated to a company with UID 3e399fca-319b-471d-a160-e186aff0adf4 on site with UID 359be228-b14d-421a-9a0e-a1a434e2195c.
Request: GET https://localhost:1280/api/v3/organizations/companies/3e399fca-319b-471d-a160-e186aff0adf4/sites/359be228-b14d-421a-9a0e-a1a434e2195c/replicationResources
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "70581c6c-5a08-4e8c-aab3-826a13f45236", "companyUid": "3e399fca-319b-471d-a160-e186aff0adf4", "siteUid": "359be228-b14d-421a-9a0e-a1a434e2195c", "hardwarePlanUid": "c3c54747-7851-4533-bc03-a7565a2e0fdb", "isWanAccelerationEnabled": false, "wanAccelerationUid": "00000000-0000-0000-0000-000000000000" }, { "instanceUid": "7a61a52d-730d-4277-8f44-d5a4a6fe54e0", "companyUid": "3e399fca-319b-471d-a160-e186aff0adf4", "siteUid": "359be228-b14d-421a-9a0e-a1a434e2195c", "hardwarePlanUid": "6d084b55-6348-4656-88ab-d3516e9385f6", "isWanAccelerationEnabled": false, "wanAccelerationUid": "00000000-0000-0000-0000-000000000000" } ] } |