This is an archive version of the document. To get the most up-to-date information, see the current version.Get Management Agent
You can get a resource representation of a management agent 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 management agent, send the GET HTTP request to the URL of the /infrastructure/managementAgents/{managementAgentUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/managementAgents/{managementAgentUid} |
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 |
|---|---|---|---|---|---|
managementAgentUid | Path | String (uuid) | Yes | — | Management agent 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 ManagementAgent schema.
Example 
The following request returns a representation of a management agent with UID 0fcb18d2-686a-47d5-a8ad-5b3317f8c657.
Request: GET https://localhost:1280/api/v3/infrastructure/managementAgents/0fcb18d2-686a-47d5-a8ad-5b3317f8c657
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "0fcb18d2-686a-47d5-a8ad-5b3317f8c657", "locationUid": "9338b8fc-cf22-47a0-85d7-ab29f250574d", "organizationUid": "40cf3b86-ccb6-43c7-8826-90b0c3287439", "hostName": "srv03", "lastHearbeatTime": "2020-03-28T04:42:43.4424137+03:00", "version": "4.0.0.4859", "discoveryTime": "2020-03-28T04:20:43.5287433+03:00", "customNotes": "", "status": "healthy", "type": "client", "computerInfo": { "uniqueUid": "2ad46349-c9c5-4141-932a-4a1f6093dc8a", "biosUuid": "1f6be4a1-ae79-41b4-a90a-b7c9f9b6565e", "hostName": "srv03", "fqdn": "srv03.prod.local", "guestOs": "Microsoft Windows 10 Pro", "guestOsType": "workstation", "guestOsVersion": "10.0.17763", "guestOsSku": 48, "platformType": "vSphere", "ipAddresses": [ "172.24.145.33" ], "macAddresses": [ "00:50:56:BB:1C:E8" ] }, "connectionStatus": "online", "isRebootRequired": false, "connectionAcount": "7ae62c53-de85-4d7c-b8fc-7341c8507c3e", "versionStatus": "upToDate", "role": "client" } } |