GET /v2/vpc_nat_gateways

To list all VPC NAT gateways in your team, send a GET request to /v2/vpc_nat_gateways. The response body will be a JSON object with a key of vpc_nat_gateways containing an array of VPC NAT gateway objects. These each contain the standard VPC NAT gateway attributes.

Servers

Query parameters

Name Type Required Description
page Integer No

Which 'page' of paginated results to return.

Default value: 1

region String No

The region where the VPC NAT gateway is located.

Valid values:

  • "sfo3"
  • "sfo1"
  • "sgp1"
  • "sfo2"
  • "blr1"
  • "nyc1"
  • "nyc2"
  • "nyc3"
  • "lon1"
  • "fra1"
  • "ams3"
  • "atl1"
  • "ams2"
  • "syd1"
  • "tor1"
name String No

The name of the VPC NAT gateway.

per_page Integer No

Number of items returned per page

Default value: 20

type String No

The type of the VPC NAT gateway.

Valid values:

  • "public"
state String No

The current state of the VPC NAT gateway.

Valid values:

  • "active"
  • "provisioning"
  • "error"
  • "new"
  • "invalid"
  • "deleting"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.