Get Backup Server
You can get a resource representation of a Veeam Backup & Replication server with the specified UID.
Request
To get a representation of a Veeam Backup & Replication server with the specified UID, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | yes | — | Backup server UID |
Response
The server returns the following response to the client.
Response Code
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: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation based on the BackupServer schema.
Example
The following request returns a representation of a Veeam Backup & Replication server with UID 818c417f-d476-410b-93fd-037656381251.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/818c417f-d476-410b-93fd-037656381251
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "818c417f-d476-410b-93fd-037656381251", "name": "cloud_srv02", "locationUid": "128a189b-0934-4744-a3c2-c440b2b8e246", "managementAgentUid": "73e6dffd-f872-4c1d-80f4-883ac9476bcd", "version": "10.0.0.4461", "installationUid": "b70ee513-7ae3-4a38-9d8e-643cb7658683", "backupServerRoleType": "cloudConnect", "status": "healthy" } } |