Veeam Recovery Orchestrator 7.2
REST API Reference
Related documents

Scopes

The /Scopes resource collection represents all scopes created in Orchestrator. The collection includes resources which represent individual scopes and have specific system IDs.

NOTE
A range of data available to a client in the Orchestrator REST API depends on permissions of the account under which the client is currently logged in.

Get Collection of Orchestrator Scopes

The HTTP GET request to the /Scopes endpoint retrieves a list of all created Orchestrator scopes.

SecurityuserAuth or clientAuth
Request
query Parameters
start
integer <int32>

Excludes the first N items of a resource collection from the response.

limit
integer <int32>

Specifies the maximum number of items of a resource collection to return in a response.

Array of objects (Expression)

Returns only specific items of a resource collection in the response. To learn how to use the filter parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.

Array of objects (SortQuery)

Specifies the order of items of a resource collection in the response. To learn how to use the sort parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses
200

OK

400

Bad request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/Scopes
Request samples 
Response samples 
{
  • "total": 2,
  • "data": [
    ]
}
Get Collection of YARA Rules for Scope
The GET request to the /api/v7.1/Scopes/{scopeId}/YaraRules endpoint retrieves a list of all YARA rules added to a specific Orchestrator scope.


SecurityuserAuth or clientAuth 
Request 
path Parameters
scopeId
required
string <uuid> 
System ID assigned to an Orchestrator scope.


 
query Parameters
start
integer <int32> 
Excludes the first N items of a resource collection from the response.


 
limit
integer <int32> 
Specifies the maximum number of items of a resource collection to return in a response.


 
Array of objects (Expression) 
Returns only specific items of a resource collection in the response. To learn how to use the filter parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.


 
Array of objects (SortQuery) 
Specifies the order of items of a resource collection in the response. To learn how to use the sort parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.


 
Responses 
200
OK


400
Bad request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized request. The authorization header has been expected but not found (or found but expired).


500
Internal server error.


get/api/v7.21/Scopes/{scopeId}/YaraRules
Request samples 
Response samples 
{
  • "total": 1,
  • "data": [
    ]
}