GET /managedServers/{ID}
Returns a resource representation of the server having the specified ID.
Request
To get a resource representation of the server, send the GET HTTP request to the URL of the /managedServers/{ID} resource:
HTTP Request
GET https://<Enterprise-Manager>:9398/api/managedServers/{ID} |
or
GET https://<Enterprise-Manager>:9398/api/managedServers/{ID}?format=Entity |
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 /managedServers/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the server connected to Veeam Backup & Replication, for example: urn:veeam:ManagedServer:15942270-fb56-4dcc-96e9-5f80e4725a15. |
Name | String | Full DNS name or IP address of the server connected to Veeam Backup & Replication, for example: 172.16.1.102. |
Description | String | Description specified for the server in Veeam Backup & Replication. |
ManagedServerType | String | Type of the server connected to Veeam Backup & Replication. Possible values:
|
To view query parameters that you can use for filtering or sorting, see GET /query?type=ManagedServer.
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server that contains the managed server in the backup infrastructure. |
/managedServers/{ID} | Alternate | Alternate URL of the /managedServers/{ID} resource. |
/hierarchyRoots/{ID} | Related | URL of the /hierarchyRoots/{ID} resource — a related virtualization host. |
Example
The example below returns an entity representation of the server having ID 4e24d83f-2403-455c-8454-54e4eda8da34:
Request: GET https://localhost:9398/api/managedServers/4e24d83f-2403-455c-8454-54e4eda8da34?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |