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

Create Company Site Resource

You can allocate a new site resource to a company 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 allocate a new site resource to a company, send the POST HTTP request to the URL of the /organizations/companies/{companyUid}/sites resource.

HTTP Request

POST https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/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.
Content-Type	Required	application/json	Identifies a media type that is used in the body of the request.
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
includeInSummaryEmail	Query	Boolean	No	—	Defines if credentials of a company owner must be sent to a service provider. False by default.
Body	Body	CompanySiteResource	Yes	—	Site resource properties

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 created resource representation based on the CompanySiteResource schema.

Example Create Company Site Resource

The following request allocates a site resource to a company with UID d7b1ee19-d0bf-49e7-ac95-24c570a2866f.

Request:

POST https://localhost:1280/api/v3/organizations/companies/d7ddb708-e3f5-4797-80f6-9f5cda57ffe3/sites

Request Header:

Content-type: application/json

Authorization: Bearer <Access-Token>

Request Body:

{

"siteUid": "5a103eb7-0f3a-4f29-9ab4-32ad5114a918",

"cloudTenantType": "general",

"vCloudOrganizationUid": null,

"leaseExpirationEnabled": true,

"leaseExpirationDate": "2020-08-27T14:37:09.247Z",

"ownerCredentials": {

"userName": "Gamma",

"password": "Password1"

"description": "Site resource for Gamma company",

"throttlingEnabled": false,

"throttlingValue": 0,

"throttlingUnit": "MbytePerSec",

"maxConcurrentTask": 0,

"backupProtectionEnabled": false,

"backupProtectionPeriodDays": 0,

"gatewaySelectionType": "StandaloneGateways",

"gatewayPoolsUids": [],

"isGatewayFailoverEnabled": false,

"isFailoverCapabilitiesEnabled": true,

"isPublicAllocationEnabled": true,

"numberOfPublicIps": 0

}

Response Code:

200 OK

Response Body:

{

"data": {

"siteUid": "5a103eb7-0f3a-4f29-9ab4-32ad5114a918",

"cloudTenantType": "general",

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

"cloudTenantUid": "e00e43f7-d875-4b39-b1ae-da7634c30e2d",