GET /agents/protectionGroups/{ID}
Returns a resource representation of a protection group having the specified ID.
Request
To get a protection group, send the GET HTTP request to the URL of the /agents/protectionGroups/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/agents/protectionGroups/{ID} |
Request Headers
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 an entity or an entity reference of the /agents/protectionGroups/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of a protection group, for example: urn:veeam:AgentProtectionGroup:1ca088be-7a63-43b9-bda1-2db2ad7a1bd5. |
Name | String | Name of a protection group, for example: Agent Protection Group. |
RescanScheduleEnabled | Bool | Defines whether schedule for automatic computer discovery is enabled. Possible values:
|
HierarchyObjRef | HierarchyObjRefType | Reference to the protection group. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=AgentProtectionGroup.
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server where the protection group was created. |
/agents/protectionGroups/{ID} | Alternate | Alternate URL of the /agents/protectionGroups/{ID} resource. |
/agents/protectionGroups/{ID}/discoveredComputers | Down | URL of the /agents/protectionGroups/{ID}/discoveredComputers resource — a collection of discovered computers contained in the protection group. |
Example
The example below returns an entity representation of the protection group resource having ID 1ca088be-7a63-43b9-bda1-2db2ad7a1bd5.
Request: GET https://localhost:9398/api/agents/protectionGroups/1ca088be-7a63-43b9-bda1-2db2ad7a1bd5?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <AgentProtectionGroup Href="http://local.host:9399/api/agents/protectionGroups/1ca088be-7a63-43b9-bda1-2db2ad7a1bd5?format=Entity" Type="AgentProtectionGroup" Name="sql servers" UID="urn:veeam:AgentProtectionGroup:1ca088be-7a63-43b9-bda1-2db2ad7a1bd5" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |