---
title: "Get Private DNS"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/operations/get-private-dns"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# Get Private DNS

`GET` `/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}`

Operation ID: `get-private-dns`

Retrieves a Private DNS by ID for a given network.

## Path parameters

- `networkId` (string, uuid, required) - The network to operate on.
- `privateDnsId` (string, uuid, required) - The ID of the Private DNS to operate on.

## Responses

- `200` - Response format for retrieving a Private DNS.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
paths:
  /cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}:
    get:
      operationId: get-private-dns
      summary: Get Private DNS
      description: Retrieves a Private DNS by ID for a given network.
      parameters:
        - $ref: "#/components/parameters/NetworkId"
        - $ref: "#/components/parameters/PrivateDnsId"
      responses:
        "200":
          $ref: "#/components/responses/RetrievePrivateDnsResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Private DNS
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    NetworkId:
      name: networkId
      in: path
      description: The network to operate on.
      required: true
      schema:
        $ref: "#/components/schemas/NetworkId"
    PrivateDnsId:
      name: privateDnsId
      in: path
      description: The ID of the Private DNS to operate on.
      required: true
      schema:
        $ref: "#/components/schemas/PrivateDnsId"
  responses:
    RetrievePrivateDnsResponse:
      description: Response format for retrieving a Private DNS.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PrivateDnsResponse"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    NetworkId:
      description: The network ID to operate on. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: string
      format: uuid
      example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695
    PrivateDnsId:
      type: string
      format: uuid
      example: 1850820b-c69f-4a2a-b9be-bbcdbc5cd618
      readOnly: true
    PrivateDnsResponse:
      oneOf:
        - $ref: "#/components/schemas/AwsPrivateHostedZoneResponse"
        - $ref: "#/components/schemas/AwsPrivateDnsResolverResponse"
        - $ref: "#/components/schemas/GcpPrivateHostedZoneResponse"
        - $ref: "#/components/schemas/AzurePrivateHostedZoneResponse"
        - $ref: "#/components/schemas/AzurePrivateDnsResolverResponse"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    AwsPrivateHostedZoneResponse:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/PrivateDnsId"
        state:
          $ref: "#/components/schemas/PrivateDnsState"
        state_metadata:
          description: >
            Metadata describing the backing state of the Private Dns and why it
            may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the Private Dns from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the Private Dns may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Failed to create Private Dns due to invalid Cloud Provider
                configuration.
          title: PrivateDnsStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the Private DNS, to
            indicate the order of updates to the

            Private DNS.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of Private DNS creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of Private DNS update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        name:
          $ref: "#/components/schemas/PrivateDnsName"
        private_dns_attachment_config:
          $ref: "#/components/schemas/AwsPrivateHostedZoneAttachmentConfig"
      required:
        - id
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
        - name
        - private_dns_attachment_config
    AwsPrivateDnsResolverResponse:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/PrivateDnsId"
        state:
          $ref: "#/components/schemas/PrivateDnsState"
        state_metadata:
          description: >
            Metadata describing the backing state of the Private Dns and why it
            may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the Private Dns from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the Private Dns may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Failed to create Private Dns due to invalid Cloud Provider
                configuration.
          title: PrivateDnsStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the Private DNS, to
            indicate the order of updates to the

            Private DNS.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of Private DNS creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of Private DNS update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        name:
          $ref: "#/components/schemas/PrivateDnsName"
        private_dns_attachment_config:
          $ref: "#/components/schemas/AwsPrivateDnsResolverAttachmentConfig"
      required:
        - id
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
        - name
        - private_dns_attachment_config
    GcpPrivateHostedZoneResponse:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/PrivateDnsId"
        state:
          $ref: "#/components/schemas/PrivateDnsState"
        state_metadata:
          description: >
            Metadata describing the backing state of the Private Dns and why it
            may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the Private Dns from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the Private Dns may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Failed to create Private Dns due to invalid Cloud Provider
                configuration.
          title: PrivateDnsStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the Private DNS, to
            indicate the order of updates to the

            Private DNS.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of Private DNS creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of Private DNS update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        name:
          $ref: "#/components/schemas/PrivateDnsName"
        private_dns_attachment_config:
          $ref: "#/components/schemas/GcpPrivateHostedZoneAttachmentConfig"
      required:
        - id
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
        - name
        - private_dns_attachment_config
    AzurePrivateHostedZoneResponse:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/PrivateDnsId"
        state:
          $ref: "#/components/schemas/PrivateDnsState"
        state_metadata:
          description: >
            Metadata describing the backing state of the Private Dns and why it
            may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the Private Dns from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the Private Dns may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Failed to create Private Dns due to invalid Cloud Provider
                configuration.
          title: PrivateDnsStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the Private DNS, to
            indicate the order of updates to the

            Private DNS.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of Private DNS creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of Private DNS update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        name:
          $ref: "#/components/schemas/PrivateDnsName"
        private_dns_attachment_config:
          $ref: "#/components/schemas/AzurePrivateHostedZoneAttachmentConfig"
      required:
        - id
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
        - name
        - private_dns_attachment_config
    AzurePrivateDnsResolverResponse:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/PrivateDnsId"
        state:
          $ref: "#/components/schemas/PrivateDnsState"
        state_metadata:
          description: >
            Metadata describing the backing state of the Private Dns and why it
            may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the Private Dns from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the Private Dns may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Failed to create Private Dns due to invalid Cloud Provider
                configuration.
          title: PrivateDnsStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the Private DNS, to
            indicate the order of updates to the

            Private DNS.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of Private DNS creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of Private DNS update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        name:
          $ref: "#/components/schemas/PrivateDnsName"
        private_dns_attachment_config:
          $ref: "#/components/schemas/AzurePrivateDnsResolverAttachmentConfig"
      required:
        - id
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
        - name
        - private_dns_attachment_config
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    PrivateDnsState:
      description: >
        The current state of the Private DNS attachment. Possible values:

        - `created` - The attachment has been created but is not attached to
        Private DNS.

        - `initializing` - The attachment is in the process of being initialized
        and is setting up necessary resources.

        - `pending-association` The attachment request is awaiting association
        to the cloud provider infrastructure in order for provisioning to
        proceed.

        - `ready` - The attachment is fully operational and can route traffic as
        configured.

        - `error` - The attachment is in an error state, and is not operational.

        - `terminating` - The attachment is in the process of being deleted.

        - `terminated` - The attachment has been fully deleted and is no longer
        available.
      type: string
      enum:
        - created
        - initializing
        - pending-association
        - ready
        - error
        - terminating
        - terminated
      title: Private DNS State
    PrivateDnsName:
      description: Human-readable name of the Private DNS.
      type: string
      example: us-east-2 private dns
      title: Private DNS Name
    AwsPrivateHostedZoneAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - aws-private-hosted-zone-attachment
          title: AWS Private Hosted Zone Type
        hosted_zone_id:
          description: AWS Hosted Zone to create attachment to.
          type: string
          title: Hosted Zone Id
      additionalProperties: false
      required:
        - kind
        - hosted_zone_id
      title: AWS Private Hosted Zone Attachment Config
    AwsPrivateDnsResolverAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - aws-outbound-resolver
          title: AWS Private DNS Resolver Type
        dns_config:
          $ref: "#/components/schemas/PrivateDnsResolverConfig"
      additionalProperties: false
      required:
        - kind
        - dns_config
      title: AWS Private DNS Resolver Attachment Config
    GcpPrivateHostedZoneAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - gcp-private-hosted-zone-attachment
          title: GCP Private Hosted Zone Type
        domain_name:
          description: Domain name to create attachment to.
          type: string
          title: Domain Name
        peer_project_id:
          description: Customer's GCP Project ID.
          type: string
          title: Peer Project Id
        peer_vpc_name:
          description: Customer's GCP VPC ID.
          type: string
          title: Peer VPC Name
      additionalProperties: false
      required:
        - kind
        - domain_name
        - peer_project_id
        - peer_vpc_name
      title: GCP Private Hosted Zone Attachment Config
    AzurePrivateHostedZoneAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - azure-private-hosted-zone-attachment
          title: Azure Private Hosted Zone Type
        domain_name:
          description: Customer's Azure Private DNS Zone Name.
          type: string
          title: Domain Name
        peer_tenant_id:
          description: Customer's Azure Tenant ID.
          type: string
          title: Peer Tenant Id
        peer_subscription_id:
          description: Customer's Azure Subscription ID.
          type: string
          title: Peer Subscription Id
        peer_resource_group_id:
          description: Customer's Azure Resource Group ID.
          type: string
          title: Peer Resource Group Id
        peer_vnet_link_name:
          description: Customer's Azure VNet Link Name.
          type: string
          title: Peer VNet Link Name
      example:
        kind: azure-private-hosted-zone-attachment
        domain_name: example.private.azure.com
        peer_tenant_id: 87654321-4321-4321-4321-210987654321
        peer_subscription_id: 12345678-1234-1234-1234-123456789012
        peer_resource_group_id: customer-dns-rg
        peer_vnet_link_name: kong-vnet-link
      additionalProperties: false
      required:
        - kind
        - domain_name
        - peer_tenant_id
        - peer_subscription_id
        - peer_resource_group_id
        - peer_vnet_link_name
      title: Azure Private Hosted Zone Attachment Config
    AzurePrivateDnsResolverAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - azure-outbound-resolver
          title: Azure Private DNS Resolver Type
        dns_config:
          $ref: "#/components/schemas/PrivateDnsResolverConfig"
      example:
        kind: azure-outbound-resolver
        dns_config:
          global.api.konghq.com:
            remote_dns_server_ip_addresses:
              - 10.0.0.2
          us.api.konghq.dev:
            remote_dns_server_ip_addresses:
              - 10.0.0.8
      additionalProperties: false
      required:
        - kind
        - dns_config
      title: Azure Private DNS Resolver Attachment Config
    PrivateDnsResolverConfig:
      description: >
        Object that contains mappings from proxied internal domains to remote
        DNS server IP address for a Private DNS Resolver.
      type: object
      example:
        global.api.konghq.com:
          remote_dns_server_ip_addresses:
            - 10.0.0.2
        us.api.konghq.dev:
          remote_dns_server_ip_addresses:
            - 10.0.0.8
      additionalProperties:
        $ref: "#/components/schemas/PrivateDnsResolverConfigObject"
      title: Private DNS Resolver Config Item
    PrivateDnsResolverConfigObject:
      type: object
      properties:
        remote_dns_server_ip_addresses:
          description: IP addresses of remote DNS servers used by the Private DNS Resolver
            for DNS resolution.
          type: array
          items:
            type: string
          example:
            - 10.0.0.2
      required:
        - remote_dns_server_ip_addresses
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
