Get Company Site Resource
You can get a resource representation of company site 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 representation of company site resource, send the GET HTTP request to the URL of the /organizations/companies/{companyUid}/sites/{siteUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/sites/{siteUid} |
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 |
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 CompanySiteResource schema.
Example 
The following request returns a representation of a site resource with UID 10d0954f-714d-4869-a66a-58bf4ae9828e that is configured for a company with UID d7ddb708-e3f5-4797-80f6-9f5cda57ffe3
Request: GET https://localhost:1280/api/v3/organizations/companies/d7ddb708-e3f5-4797-80f6-9f5cda57ffe3/sites/10d0954f-714d-4869-a66a-58bf4ae9828e
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "siteUid": "10d0954f-714d-4869-a66a-58bf4ae9828e", "cloudTenantType": "general", "companyUid": "d7ddb708-e3f5-4797-80f6-9f5cda57ffe3", "cloudTenantUid": "e00e43f7-d875-4b39-b1ae-da7634c30e2d", "vCloudOrganizationUid": null, "leaseExpirationEnabled": false, "leaseExpirationDate": null, "ownerCredentials": { "userName": "Gamma", "password": null }, "description": "Site resource for Gamma company", "throttlingEnabled": false, "throttlingValue": 1, "throttlingUnit": "mbytePerSec", "maxConcurrentTask": 1, "backupProtectionEnabled": false, "backupProtectionPeriodDays": 1, "gatewaySelectionType": "standaloneGateways", "gatewayPoolsUids": [], "isGatewayFailoverEnabled": false, "isFailoverCapabilitiesEnabled": false, "isPublicAllocationEnabled": false, "numberOfPublicIps": 0 } } |
