Skip to main content
POST
Associate a VPC with a private zone
Requires the IAM action dns:AssociateVPC. See DNS 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

Path Parameters

zone_id
string<uuid>
required

DNS Zone ID

Body

application/json
vpc
string
required

Account-owned VPC UUID or network/vpc CRN to associate with this private zone. Bare names return 400 with "VPC references on DNS zones must be a UUID or a CRN, which carries the region". CRNs resolve in their named region; UUIDs search all regions enabled for DNS. Missing, foreign-account or unconfigured-region VPCs return 404. Incomplete UUID searches or duplicate regional UUID identities fail with a server error. The response contains the canonical VPC UUID.

Response

Association accepted

zone_id
string<uuid>
required
vpc_id
string<uuid>
required