This is an archive version of the document. To get the most up-to-date information, see the current version.

Get All Company Site Resources

You can get a resource representation of all site resources allocated to all companies.

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 company site resources, send the GET HTTP request to the URL of the /organizations/companies/sites collection.

HTTP Request

GET https://<hostname>:1280/api/v3/organizations/companies/sites

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
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 CompanySiteResource schema.

Example Get All Company Site Resources

The following request returns a representation of all company site resources.

Request:

GET https://localhost:1280/api/v3/organizations/companies/sites

Request Header:

Authorization: Bearer <Access-Token>

Response Code:

200 OK

Response Body:

{

"meta": {

"pagingInfo": {

"total": 2,

"count": 2,

"offset": 0

}

"data": [

{

"siteUid": "49e9d4c3-a13d-4ad5-9bdf-39fa7647385c",

"cloudTenantType": "general",

"companyUid": "d7b1ee19-d0bf-49e7-ac95-24c570a2866f",

"cloudTenantUid": "74c8bcfb-de0b-4bec-9cc7-373a21ef9cd0",

"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,

"gatewaySelectionTylpe": "standaloneGateways",

"gatewayPoolsUids": [],

"isGatewayFailoverEnabled": false,

"isFailoverCapabilitiesEnabled": false,

"isPublicAllocationEnabled": false,

"numberOfPublicIps": 0

{

"siteUid": "dedb5f58-ba02-4cac-85f1-ee0e72ccc79a",