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

Get a Site Scope

You can get a representation of a reseller site scope with the specified ID of a management agent that is installed on a service provider Veeam Cloud Connect server.

Request

To get a representation of a reseller site scope Veeam Availability Console, send the GET HTTPS request to the URL of the /resellers/{ID}/siteScopes/{cloudConnectAgentUid} resource.

HTTP Request

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

Request Headers

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

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

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 representation of the /resellers/{ID}/siteScopes/{cloudConnectAgentUid} resource.

Example Get a Site Scope

The following example returns a representation of a site scope with management agent ID d68b878a-0633-4dfa-a94d-82d35dda936d that is configured for a reseller with ID 2.

Request:

GET https://localhost:1281/v2/resellers/2/siteScopes/d68b878a-0633-4dfa-a94d-82d35dda936d

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 Success

 

Response Body:

 {

   "cloudConnectAgentUid": "d68b878a-0633-4dfa-a94d-82d35dda936d",

   "tenantQuota": 0,

   "tenantQuotaIsUnlimited": true,

   "siteName": "Beta",

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac.tech.local:1281/v2/resellers/2/siteScopes/d68b878a-0633-4dfa-a94d-82d35dda936d"

     }

   ]

 }

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference