Sign in

v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Private DNS

Create Private DNS

Creates a new private DNS attachment for a given network. The attachment type is determined by private_dns_attachment_config.kind. Supported types: aws-private-hosted-zone-attachment, aws-outbound-resolver, gcp-private-hosted-zone-attachment, azure-private-hosted-zone-attachment, and azure-outbound-resolver.

post/v2/cloud-gateways/networks/{networkId}/private-dns

Path parameters

networkIdstring uuid required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Request body

namestring

Human-readable name of the Private DNS.

Example request

{
  "name": "us-east-2-private-dns",
  "private_dns_attachment_config": {
    "dns_config": {
      "internal.example.com": {
        "remote_dns_server_ip_addresses": [
          "10.0.1.100"
        ]
      },
      "db.corp.internal": {
        "remote_dns_server_ip_addresses": [
          "10.0.2.100"
        ]
      }
    }
  }
}

Response

Response format for creating a Private DNS.

OR
OR
OR
OR

Example response

{
  "id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
  "state_metadata": {
    "reported_status": "ERROR",
    "reason": "Failed to create Private Dns due to invalid Cloud Provider configuration.\n"
  },
  "entity_version": 1,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "name": "us-east-2-private-dns"
}