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, 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} |
or
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. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
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:
|
Response Body
In the response body, the REST API returns an entity or an entity reference of the /cloud/gateways/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the cloud gateway, for example: urn:veeam:CloudGateway:b5025a7b-5e13-41e2-a17e-9d9af985ecfd. |
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. |
Enabled | Boolean | Defines if the cloud gateway is in the enabled or disabled state. Possible values:
|
NetworkMode | CloudGatewayNetworkingMode | Network mode:
|
ExternalIP | String | External IP address of the NAT gateway. This parameter must be specified if the cloud gateway is located behind the NAT. |
ExternalPort | UShort | TCP/IP port over which users' backup servers must communicate with the cloud gateway. By default, port 6180 is used. |
InternalPort | UShort | Port on the NAT gateway used for listening to connections from users. By default, port 6180 is used. This parameter must be specified if the cloud gateway is located behind the NAT. |
Description | String | Description for the cloud gateway. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=CloudGateway.
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server where the cloud gateway was created. |
/cloud/gateways/{ID} | Alternate | Alternate URL of the /cloud/gateways/{ID} resource. |
/cloud/gateways/{ID} | Edit | URL for the PUT /cloud/gateways/{ID} request. |
/cloud/gateways/{ID} | Delete | URL for the DELETE /cloud/gateways/{ID} request. |
/cloud/gatewayPools/{ID} | Related | URL of the /cloud/gatewayPools/{ID} resource — a cloud gateway pool that contains the gateway. |
Example
The example below returns an entity representation of the cloud gateway having ID 72165f41-2374-44b6-a9ac-c18a461e03fe.
Request: GET https://localhost:9398/api/cloud/gateways/72165f41-2374-44b6-a9ac-c18a461e03fe?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |