This is an archive version of the document. To get the most up-to-date information, see the current version.Get Company vCD Replication Resource
You can get a resource representation of a company vCD replication resource 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 resource representation of a company vCD replication resource, send the GET HTTP request to the URL of the /organizations/companies/{companyUid}/sites/{siteUid}/vcdReplicationResources/{resourceUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/sites/{siteUid}/vcdReplicationResources/{resourceUid} |
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 |
resourceUid | Path | String (uuid) | Yes | — | vCD replication resource UID |
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 resource representation based on the CompanySiteVcdReplicationResource schema.
Example 
The following request returns a representation of a vCD replication resource with UID 5c14c652-2514-44b4-9138-1fbe326d36a2.
Request: GET https://localhost:1280/api/v3/organizations/companies/494160d2-13a5-43e0-b685-4d83eb2e6a54/sites/365be228-b14d-421a-9a0e-a1a433c2195c/vcdReplicationResources/5c14c652-2514-44b4-9138-1fbe326d36a2
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "5c14c652-2514-44b4-9138-1fbe326d36a2", "companyUid": "494160d2-13a5-43e0-b685-4d83eb2e6a54", "siteUid": "365be228-b14d-421a-9a0e-a1a433c2195c", "dataCenterUid": "5c14b252-2514-44b4-9138-1fbe716d36a2", "isWanAccelerationEnabled": false, "wanAccelerationUid": null } } |