Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(GET) /cloud/gatewayPools

Returns a resource representation of a collection of cloud gateway pools configured on all Veeam Backup Servers connected to Veeam Backup Enterprise Manager.

Request

To get a list of cloud gateway pools, you need to send the GET HTTP request to the URL of the /cloud/gatewayPools resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/cloud/gatewayPools

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.

Request Body

None.

Query Parameters

 

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

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/gatewayPools resource collection.

Example

The example below returns a list of cloud gateway pools configured on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request:

GET https://localhost:9398/api/cloud/gatewayPools

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Ref UID="urn:veeam:CloudGatewayPool:6de18dab-3341-441e-9184-a866913444d4" Name="Cloud gateway pool 1" Href="http://local.host:9399/api/cloud/gatewayPools/6de18dab-3341-441e-9184-a866913444d4" Type="CloudGatewayPoolReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/cloud/gatewayPools/6de18dab-3341-441e-9184-a866913444d4?format=Entity" Name="Cloud gateway pool 1" Type="CloudGatewayPool" Rel="Alternate"/>
   </Links>
 </Ref>
</EntityReferences>

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideIntegration with Veeam Backup for AWS User GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.