Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Get Collection of VAO Scopes

You can get a list of all created VAO scopes.

Request

To retrieve a representation of a collection of VAO scopes, send the HTTP GET request to the URL of the /Scopes collection.

HTTP Request

GET https://<hostname>:<port>/v2/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 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

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 /Scopes collection.

Example Get Collection of VAO Scopes

The following request returns a full list of VAO scopes created on the VAO server with the ID 76da0d75-75b0-4675-8296-0142ad0d52a7.

Request:

GET https://uwin2012r2.n.local:9899/v2/Sites/76da0d75-75b0-4675-8296-0142ad0d52a7/Scopes

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 Success

 

Response Body:

[

 {

   "name": "Default",

   "id": "87da0cab-09f5-4b8f-bd3c-a346983c2930",

   "description": "Default scope to manage roles and permissions",

   "_links": {

     "self": {

       "href": "/v2/Sites/76da0d75-75b0-4675-8296-0142ad0d52a7/Scopes/87da0cab-09f5-4b8f-bd3c-a346983c2930"

     }

   }

 },

 {

   "name": "customScope",

   "id": "cd6aaf83-ae62-41f8-a772-4233f24967ab",

   "description": "Custom scope 1",

   "_links": {

     "self": {

       "href": "/v2/Sites/76da0d75-75b0-4675-8296-0142ad0d52a7/Scopes/cd6aaf83-ae62-41f8-a772-4233f24967ab"

     }

   }

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference