This is an archive version of the document. To get the most up-to-date information, see the current version.

Get a Backup Agent

You can get a representation of a Veeam backup agent with the specified ID.

Request

To get a representation of a Veeam backup agent, send the GET HTTPS request to the URL of its resource.

HTTPS Request

GET https://<hostname>:1281/v2/backupAgents/{ID}

Request Headers

The request header must contain the authorization token.

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 representation of the /backupAgents/{ID} resource.

Example Get a Backup Agent

The following request returns a representation of a Veeam backup agent with ID 41149d13-eb49-4895-9053-27f227584e4f.