ACLs7

Add-Ons5

AI Gateway Agents5

AI Gateway Auth Strategies5

AI Gateway CA Certificates5

AI Gateway Certificates5

AI Gateway Config Stores10

AI Gateway Consumer Groups8

AI Gateway Consumers11

AI Gateway DataPlane Certificates4

AI Gateway Identity Providers5

AI Gateway MCP Servers5

AI Gateway Model Providers5

AI Gateway Models5

AI Gateway Nodes3

AI Gateway Policies5

AI Gateway SNIs10

AI Gateway Vaults5

AI Gateways6

API6

API Attributes1

API Documentation6

API Image4

API Implementation4

API Operations2

API Package Documentation6

API Package Image4

API Package Operations4

API Package Specification4

API Packages5

API Publication8

API Specification6

API Version5

API-keys7

App Auth Strategies6

Application Registrations8

Applications8

Assets6

Auth Settings17

Authentication1

Basic-auth credentials7

CA Certificates5

Catalog Integrations1

Catalog Resource Mappings4

Catalog Resource Services1

Catalog Resources3

Catalog Service API Mappings5

Catalog Service Resources1

Catalog Services5

Certificates5

Cloud Gateways Resource Quotas3

Config Store Secrets5

Config Stores5

Consumer Groups9

Consumers9

Control Plane Groups6

Control Planes5

Criteria Templates1

Custom Domains5

Custom Plugin Schemas5

CustomPlugins5

Dashboards5

Data-Plane Group Configurations3

DCR Providers6

Degraphql_routes7

DP Certificates5

DP Nodes6

Event Gateway Backend Clusters5

Event Gateway DataPlane Certificates5

Event Gateway Listener Policies9

Event Gateway Listeners5

Event Gateway Nodes4

Event Gateway Schema Registries5

Event Gateway Static Keys4

Event Gateway TLS Trust Bundles5

Event Gateway Virtual Cluster Consume Policies9

Event Gateway Virtual Cluster Policies9

Event Gateway Virtual Cluster Produce Policies9

Event Gateway Virtual Clusters5

Event Gateways6

GraphQL Cost Decorations7

HMAC-auth credentials7

Impersonation Settings2

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances5

Invites1

JWTs7

Keys10

KeySets5

MCP Server Runtime1

MCP Servers6

Me2

Metering Events2

Meters6

MTLS-auth credentials7

Networks6

Notifications11

OpenMeter Apps2

OpenMeter Billing Settings5

OpenMeter Customers19

OpenMeter Defaults2

OpenMeter Entitlements1

OpenMeter Features6

OpenMeter LLM Cost5

OpenMeter Product Catalog19

OpenMeter Subscriptions8

OpenMeter Tax5

Pages7

Partial Links1

Partials5

Personal Access Tokens6

Plugins26

Portal Audit Logs6

Portal Auth Settings13

Portal Custom Domains4

Portal Customization3

Portal Developers5

Portal Emails19

Portal Integrations3

Portal Team Membership4

Portal Team Roles4

Portal Teams5

Portals5

Portals IP Allow List6

Private DNS5

Provider Accounts2

Resource Availability1

Resource Configurations3

Roles9

Routes10

Schemas2

Scorecards11

Services5

Skills2

Snippets5

SNIs10

System Accounts5

System Accounts - Access Tokens5

System Accounts - Roles4

System Accounts - Team Membership4

Targets6

Team Membership4

Teams5

Transit Gateways5

Upstreams5

Users4

Vaults5

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.

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"
}

Changes

Changed in 8 of the 75 revisions of this API.39126

Feb 12, 2026b9b4ba83d16d3See the full diff
- ○
  added to the request property oneOf list
  request-property-one-of-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
Jan 20, 20267bc7400170e01See the full diff
- ▲
  added to the response body oneOf list for the response status
  response-body-one-of-added
Oct 23, 20258ab3ec3ed3011See the full diff
- ●
  added the new type enum value to the /////// response property for the response status
  response-property-enum-value-added
Sep 11, 2025396c243e49dc2See the full diff
- ○
  added to the request property oneOf list
  request-property-one-of-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 20253c0154b2053a17See the full diff
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///// became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 20256333a0d3b095318See the full diff
- ▲
  added to the response body oneOf list for the response status
  response-body-one-of-added
- ▲
  the /// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /// response's property type changed from no type to object for status
  response-property-type-changed
- ○
  removed subschema #2 from the /// response property allOf list for the response status
  response-property-all-of-removed
- ○
  removed subschema #2 from the /// response property allOf list for the response status
  response-property-all-of-removed
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 202576b0fefddb0d182See the full diff
- ▲
  the /// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the /// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ▲
  removed the required property //// from the response with the status
  response-required-property-removed
- ○
  added subschema #2 to the /// response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the /// response property allOf list for the response status
  response-property-all-of-added
Jun 27, 20250aead68de7b01See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history