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

Changes

Changed in 6 of the 52 revisions of this API.1614

  • d1aa59a0a11512See the full diff
    • ▲

      added AzurePrivateHostedZoneResponse to the response body oneOf list for the response status 201

      response-body-one-of-added

    • ○

      added AzurePrivateHostedZoneAttachmentConfig AzurePrivateDnsResolverAttachmentConfig to the private_dns_attachment_config request property oneOf list

      request-property-one-of-added

    • ○

      added the required property oneOf[AzurePrivateDnsResolverResponse]/private_dns_attachment_config to the response with the 201 status

      response-required-property-added

  • 4b75c54c0f2b1See the full diff
    • ▲

      added AzurePrivateDnsResolverResponse to the response body oneOf list for the response status 201

      response-body-one-of-added

  • 19e869275e281See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f0305901662211See the full diff
    • ▲

      added GcpPrivateHostedZoneResponse to the response body oneOf list for the response status 201

      response-body-one-of-added

    • ○

      added GcpPrivateHostedZoneAttachmentConfig to the private_dns_attachment_config request property oneOf list

      request-property-one-of-added

  • 96118a9cd7f413See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property oneOf[AwsPrivateDnsResolverResponse]/state_metadata/reason became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property oneOf[AwsPrivateDnsResolverResponse]/state_metadata/reported_status became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property oneOf[AwsPrivateHostedZoneResponse]/state_metadata/reason became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property oneOf[AwsPrivateHostedZoneResponse]/state_metadata/reported_status became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60ce7598bbd01See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog