GET /security/accounts/{ID}/scopes/{ID}
Returns a restore scope having the specified ID. The scope is defined for the account that is added to Veeam Backup Enterprise Manager and is assigned a specific security role.
Request
To get a restore scope defined for the account having the specified ID, send the GET HTTP request to the URL of the /security/accounts/{ID}/scopes/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/security/accounts/{ID}/scopes/{ID} |
Request Header
The request contains the following headers:
Header | Required | Description |
---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
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. Possible values:
|
Response Body
In the response body, the REST API returns the /security/accounts/{ID}/scopes/{ID} resource that contains the following parameters and links.
Parameters
Element | Type | Description |
---|---|---|
Name | String | Name of the virtualization object assigned as a scope, for example: Enterprise. |
HierarchyRootName | String | ID of the hierarchy root object assigned as a scope, for example: 24a14898-77d0-4881-bbf8-c8ba71ce4d55. |
Platform | String | Platform of the virtualization object. Possible values:
|
HierarchyObjectType | String | Type of the hierarchy object, for example: ResourcePool, VcdSystem. |
State | String | State of the session that processes the scope. Possible values:
|
Links
Reference | Relationship | Description |
---|---|---|
/security/accounts/{ID}/scopes/{ID} | Delete | URL for the DELETE /security/accounts /{ID}/scopes/{ID} request. |
Example
The example below returns a restore scope having ID bceb75f9-5c10-4f39-9eb5-c000a2fabaee for the account having ID de19303b-bcf3-428b-b113-ac0b2cf46bd7.
Request: GET https://localhost:9398/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7/scopes/bceb75f9-5c10-4f39-9eb5-c000a2fabaee
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <EnterpriseAccountHierarchyScope xmlns="http://www.veeam.com/ent/v1.0" Href="https://localhost:9398/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7/scopes/bceb75f9-5c10-4f39-9eb5-c000a2fabaee"> |