Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Create a Site Scope

You can configure a site scope for a reseller with a specified ID.

Request

To create a site scope, send the POST HTTPS request to the URL of the /resellers/{ID}/siteScopes resource.

HTTP Request

POST https://<Availability-Console>:1281/v2/resellers/{ID}/siteScopes

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

In the request body, the client must send the following properties for the site scope that must be added to Veeam Availability Console:

  • cloudConnectAgentUid
  • tenantQuota
  • tenantQuotaIsUnlimited

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 201 Created.

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 Availability Console returns a status and a message for an action.

Example Create a Site Scope

The following example adds a new site scope for a reseller with ID 2.

Request:

POST https://localhost:1281/v2/resellers/2/siteScopes

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "cloudConnectAgentUid": "30689f1c-85d0-5dcf-b31d-556332912254",

 "tenantQuota": 10,

 "tenantQuotaIsUnlimited": false

}

 

Response Code:

201 Created

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference