Get Veeam Backup Enterprise Manager
You can get a resource representation of 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 a Veeam Backup Enterprise Manager, send the GET HTTP request to the URL of the /infrastructure/enterpriseManagers/{enterpriseManagerUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/enterpriseManagers/{enterpriseManagerUid} |
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 resource representation based on the EnterpriseManager schema.
Example
The following request returns a representation of a Veeam Backup Enterprise Manager with UID 72eb352d-28d9-4923-826a-847f634248ff.
Request: GET https://localhost:1280/api/v3/infrastructure/enterpriseManagers/72eb352d-28d9-4923-826a-847f634248ff
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "72eb352d-28d9-4923-826a-847f634248ff", "name": "emsrv2", "managementAgentUid": "72eb35dd-21d9-4923-826a-847f634248ff", "installationUid": "62d8fd1a-0db1-4883-8b8c-09c6eab01bdd", "version": "10.0.0.4461", "status": "healthy" } } |