This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /managedServers/{ID}
Returns a resource representation of the server having the specified ID.
Request
To get a resource representation of the server, you need to send the GET HTTP request to the URL of the /managedServers/{ID} resource:
HTTP Request
or
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. To learn more, 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.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
UID | URN | ID of the server connected to Veeam Backup & Replication, for example: urn:veeam:ManagedServer:15942270-fb56-4dcc-96e9-5f80e4725a15. | True | True |
Name | String | Full DNS name or IP address of the server connected to Veeam Backup & Replication. for example: 172.16.1.102. | True | True |
Description | String | Description specified for the server in Veeam Backup & Replication. | True | True |
ManagedServerType | String | Type of the server connected to Veeam Backup & Replication. Possible values:
| True | True |
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, Veeam Backup Enterprise Manager returns a representation of the /managedServers/{ID} resource.
Example
The example below returns an entity representation of the server having ID a5352877-3b99-4e2a-8700-400cb3eefb56:
Request: GET https://localhost:9398/api/managedServers/a5352877-3b99-4e2a-8700-400cb3eefb56?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <ManagedServer xmlns="http://www.veeam.com/ent/v1.0" Type="ManagedServer" Href="https://localhost:9398/api/managedServers/a5352877-3b99-4e2a-8700-400cb3eefb56?format=Entity" Name="172.16.16.77" UID="urn:veeam:ManagedServer:a5352877-3b99-4e2a-8700-400cb3eefb56"> |
The example below executes a query to get a Veeam backup server having IP address 172.16.0.11:
Request: GET https://localhost:9398/api/query?type=managedServer&filter=name=="172.16.0.11"
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <ManagedServer xmlns="http://www.veeam.com/ent/v1.0" Type="ManagedServer" Href="https://localhost:9398/api/managedServers/a5352877-3b99-4e2a-8700-400cb3eefb56?format=Entity" Name="172.16.0.11" UID="urn:veeam:ManagedServer:a5352877-3b99-4e2a-8700-400cb3eefb56"> |
