Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Get Collection of Scopes on VAO Server

You can get a list of VAO scopes created on the VAO server with the specified ID.

Request

To retrieve a collection representation of VAO scopes, send the HTTP GET request to the /Sites/{siteId}/Scopes endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v3/Sites/{siteId}/Scopes

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/xml
  • text/json
  • 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.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 200 response code.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

In the response body, VAO returns a representation of the /Sites/{siteId}Scopes/ collection. The SiteScopeInfo schema is used for the resource collection representation.

Get Collection of Scopes on VAO ServerExample

The following example returns a collection representation of VAO scopes created on the VAO server with the ID ab6dfa51-c6c3-49ef-9291-067194635e37.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/Sites/ab6dfa51-c6c3-49ef-9291-067194635e37/Scopes

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 2,

 "data": [

   {

     "id": "2a87b084-1e8c-42c6-b91f-ad370576e473",

     "name": "Admin Scope",

     "description": "Default Scope containing administrative roles",

     "isDefault": true,

     "state": "Active",

     "serverId": "ab6dfa51-c6c3-49ef-9291-067194635e37",

     "siteName": "Ontario"

   },

   {

     "id": "539633fa-1188-4d71-8d43-6f942e8d7d3e",

     "name": "customScope",

     "description": "Custom Auto Scope",

     "isDefault": false,

     "state": "Active",

     "serverId": "ab6dfa51-c6c3-49ef-9291-067194635e37",

     "siteName": "Ontario"

   }

 ]

}

This Document Help Center
User GuideGroup Management GuideREST API ReferenceVeeam Backup & Replication DocumentationVeeam ONE Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.