Get Reseller Replication Resource
You can get a resource representation of a reseller cloud 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.
Request
To get a representation of a reseller cloud replication resource, send the GET HTTP request to the URL of the /organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/{resourceUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/{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 |
---|---|---|---|---|---|
resellerUid | Path | String (uuid) | Yes | — | Reseller UID |
siteUid | Path | String (uuid) | Yes | — | Site UID |
resourceUid | Path | String (uuid) | Yes | — | Cloud 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 ResellerSiteReplicationResource schema.
Example
The following request returns a representation of a reseller replication resource with UID 84fdc816-6ec9-50f3-7224-3fa3a710662a.
Request: GET https://localhost:1280/api/v3/organizations/resellers/d7ddb708-e3f5-4797-80f6-9f5cda57ffe3/sites/10d0954f-714d-4869-a66a-58bf4ae9828e/replicationResources/84fdc816-6ec9-50f3-7224-3fa3a710662a
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "84fdc816-6ec9-50f3-7224-3fa3a710662a", "siteUid": "10d0954f-714d-4869-a66a-58bf4ae9828e", "resellerUid": "d7ddb708-e3f5-4797-80f6-9f5cda57ffe3", "hardwarePlanUid": "6d084b55-6348-4656-88ab-d8016e9475f6" } } |