Skip to main content
POST
Create NAT gateway
Requires the IAM action network:CreateNATGateway. 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.

Headers

Idempotency-Key
string

Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.

Maximum string length: 255

Body

application/json
name
string
required

Resource names must not start with the literal crn: prefix or be UUIDs (canonical, compact, braced, or urn:uuid: forms, in either case).

Example:

"main"

subnet
string
required

Subnet UUID or nested CRN (vpc//subnet/). A bare name requires an explicit VPC filter; create requests without a VPC do not accept bare names.

Example:

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

description
string
Example:

"NAT gateway for private subnet egress"

tags
object

Response

NAT gateway created

nat_gateway
object