Skip to content
StratumStratum Docs

List NAT gateways in a project.

GET
/v1/projects/{projectId}/network/nat-gateways
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/network/nat-gateways \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Query Parameters

Section titled “Query Parameters”
vpcId
string
/^vpc-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

NAT gateways.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
/^natgw-[a-z0-9-]+$/
projectId
required
string
vpcId
required
string
/^vpc-[a-z0-9-]+$/
subnetId
required

Public subnet where the NAT GW lives (consumes one IP from its IPAM).

string
/^subnet-[a-z0-9-]+$/
nicId

Platform-owned NIC ID for the NAT GW’s LSP in the public subnet.

string
region
required
string
availabilityZone
required
string
floatingIPId
required
string
/^fip-[a-z0-9-]+$/
state
required
string
Allowed values: creating available deleting deleted error
tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object
<= 50 properties
key
additional properties
string
<= 256 characters
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
deletedAt
string format: date-time
createdBy
string
nextPageToken
string
isTruncated

True when the server had more rows than it returned. The response is a valid prefix of the result, not the whole of it.

Without this flag a client at the server’s row ceiling receives a full page and no nextPageToken, which means “this is the complete set” — so data it never saw would be indistinguishable from data that does not exist.

It does not imply a cursor exists. These queries do not all sort on a total order, so a resumable token cannot be minted for them yet. The remedy is to narrow the request (a filter, or a tighter scope), not to page.

boolean

Example 

{
  "items": [
    {
      "state": "creating"
    }
  ]
}