Private DNS

Update Private DNS

Changed on

Updates a private DNS attachment by ID. Supports updating the name or DNS resolver configuration for AWS Outbound Resolver and Azure Outbound Resolver attachment types.

patch/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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.

privateDnsIdstring uuid required
Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618

The ID of the Private DNS to operate on.

Request body

OR

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 updating 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

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status