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

(GET) /cloud/gateways/{ID}

Returns a resource representation of a cloud gateway having the specified ID.

Request

To get a resource representation of the cloud gateway, you need to send the GET HTTP request to the URL of the /cloud/gateways/{ID} resource:

HTTP Request

GET https://<Enterprise-Manager>:9398/api/cloud/gateways/{ID}

GET https://<Enterprise-Manager>:9398/api/cloud/gateways/{ID}?format=Entity

Request Headers

The request contains the following headers:

Header	Required	Description
X-RestSvcSessionId	True	The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.
Accept	False	Identifies the format of the response. Possible values: application/xml — the client can send this value in the header to accept response in the XML format. application/json — the client must send this value in the header to accept the request in the JSON format. If the request does not contain the header, the server will return the response in the XML format.

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

False

Identifies the format of the response. Possible values:

application/xml — the client can send this value in the header to accept response in the XML format.
application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Query Parameters

The following parameters can be used in queries:

Parameter	Type	Description	Can Be Used for Filtering	Can Be Used for Sorting
Uid	URN	ID of the cloud gateway, for example: urn:veeam:CloudGateway:b5025a7b-5e13-41e2-a17e-9d9af985ecfd	True	True
Name	String	DNS name or IP address (depending on what was used in POST request when creating the cloud gateway) of the the cloud gateway, for example: srv01.tech.local.	True	True
Enabled	Boolean	Defines if the cloud gateway is in the enabled or disabled state. Possible values: True False	True	True
Description	String	Description of the cloud gateway.	True	True
BackupServerUId	URN	ID of the Veeam backup server parent to the cloud gateway resource.	True	True
BackupServerName	String	Name of the Veeam backup server parent to the cloud gateway resource.	True	True

Response

The server returns the following response to the client.

Response Codes

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. Possible values: application/xml application/json

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

application/xml
application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/gateways/{ID} resource.

Example

The example below returns an entity reference representation of the cloud gateway having ID b5025a7b-5e13-41e2-a17e-9d9af985ecfd.

Request:

GET https://localhost:9398/api/cloud/gateways/b5025a7b-5e13-41e2-a17e-9d9af985ecfd

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 OK

Response Body: