Get Veeam Backup & Replication Servers Managed by Veeam Backup Enterprise Manager Server
You can get a collection resource representation of all Veeam Backup & Replication servers that are managed by a Veeam Backup Enterprise Manager with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of all Veeam Backup & Replication servers that are managed by a specific Veeam Backup Enterprise Manager, send the GET HTTP request to the URL of the /infrastructure/enterpriseManagers/{enterpriseManagerUid}/backupServers collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/enterpriseManagers/{enterpriseManagerUid}/backupServers |
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 |
---|---|---|---|---|---|
enterpriseManagerUid | Path | String (uuid) | Yes | — | Veeam Backup Enterprise Manager 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 collection resource representation based on the EnterpriseManagerBackupServer schema.
Example
The following request returns a representation of all Veeam Backup & Replication servers that are managed by a Veeam Backup Enterprise Manager with UID 9e755f28-8624-456b-9e29-f3248e5403f6.
Request: GET https://localhost:1280/api/v3/infrastructure/enterpriseManagers/9e755f28-8624-456b-9e29-f3248e5403f6/backupServers
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "a2ead214-e225-49bf-8fb8-f16340729b7b", "address": "172.24.152.151", "port": 9392, "backupServer": { "instanceUid": "a2ead214-e225-49bf-8fb8-f16340729b7b", "name": "backup_srv3", "locationUid": "ab774cb1-a5ed-4e33-a964-6345447378a3", "managementAgentUid": "3dc19a4e-45cb-4639-91f1-b69c48c1e4cb", "version": "10.0.0.4461", "installationUid": "70e05c74-85a3-47ba-a513-f7f9f85ad1ad", "backupServerRoleType": "client", "status": "healthy" } }, { "instanceUid": "4345d602-2956-4086-9800-30b467e5ff46", "address": "172.24.151.115", "port": 9392, "backupServer": { "instanceUid": "4345d602-2956-4086-9800-30b467e5ff46", "name": "backup_srv4", "locationUid": "db5513e4-5c61-4e88-99cf-f604a148becb", "managementAgentUid": "ee2d773f-e930-48f4-ace4-f100ce50eff3", "version": "10.0.0.4461", "installationUid": "f18bc9f2-4fbd-4abc-856c-828e1f0356df", "backupServerRoleType": "client", "status": "healthy" } } ] } |