Skip to main content
GET
List NAT gateways
Requires the IAM action network:ListNATGateways. See NETWORK permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Query Parameters

name
string

Exact resource name.

crn
string

Exact CRN, validated against the endpoint type, region and caller account. Valid foreign or mismatched CRNs return an empty result; malformed or flat child CRNs return 400. Filters are conjunctive.

subnet
string

Subnet UUID or nested CRN; an exact bare name requires the vpc filter.

Example:

"7a1c9d3e-2f5b-4c8a-9e6d-3b2a1c4f5e8d"

vpc
string

VPC UUID, CRN or exact account-scoped name. Resolved before subnet.

Example:

"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f"

limit
integer
default:50
Required range: 1 <= x <= 500
Example:

50

marker
string<uuid>

Resume token — the last id from the previous page.

Example:

"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f"

Response

List of NAT gateways

nat_gateways
object[]
required
meta
object
required