> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify the organisation's custom DNS zones

> Probes what public DNS answers today for every custom DNS zone the organisation declares - organisation-wide and bound to single clusters - and reports an honest three-state verdict per zone: verified, misconfigured with the observed-vs-expected facts, or unknown when a probe could not be completed. Read-only end to end: it verifies what the customer's DNS resolves and names the record they would need to create themselves; it never writes DNS records anywhere.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/custom-dns-zones/verification
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
paths:
  /api/v1/org/custom-dns-zones/verification:
    get:
      tags:
        - Organisation
      summary: Verify the organisation's custom DNS zones
      description: >-
        Probes what public DNS answers today for every custom DNS zone the
        organisation declares - organisation-wide and bound to single clusters -
        and reports an honest three-state verdict per zone: verified,
        misconfigured with the observed-vs-expected facts, or unknown when a
        probe could not be completed. Read-only end to end: it verifies what the
        customer's DNS resolves and names the record they would need to create
        themselves; it never writes DNS records anywhere.
      operationId: verify_organisation_custom_dns_zones_token
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/OrganisationCustomDNSZoneVerificationResponse
          description: The verification verdict per declared zone
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Permission or CSRF check failed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Resource not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Provider or internal failure
      security:
        - BearerAuth: []
components:
  schemas:
    OrganisationCustomDNSZoneVerificationResponse:
      properties:
        success:
          type: boolean
        zones:
          items:
            $ref: '#/components/schemas/CustomDNSZoneVerification'
          type: array
      required:
        - success
        - zones
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CustomDNSZoneVerification:
      properties:
        zone:
          type: string
        credential_name:
          type: string
        scope:
          enum:
            - organisation
            - cluster
          type: string
        cluster_id:
          type: string
        cluster_name:
          type: string
        verdict:
          enum:
            - verified
            - misconfigured
            - unknown
          type: string
        checks:
          items:
            $ref: '#/components/schemas/CustomDNSZoneCheck'
          type: array
      required:
        - zone
        - credential_name
        - scope
        - cluster_id
        - cluster_name
        - verdict
        - checks
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    CustomDNSZoneCheck:
      properties:
        check:
          enum:
            - credential
            - zone_delegation
            - published_hostnames
          type: string
        state:
          enum:
            - passed
            - failed
            - unknown
            - not_applicable
          type: string
        observed:
          type: string
        expected:
          type: string
        hostnames:
          items:
            $ref: '#/components/schemas/CustomDNSHostnameProbe'
          type: array
      required:
        - check
        - state
        - observed
        - expected
      type: object
    CustomDNSHostnameProbe:
      properties:
        hostname:
          type: string
        cluster_name:
          type: string
        state:
          enum:
            - resolved
            - unresolved
            - mismatched
            - unknown
          type: string
        observed_addresses:
          items:
            type: string
          type: array
        expected_addresses:
          items:
            type: string
          type: array
        required_record:
          $ref: '#/components/schemas/CustomDNSRequiredRecord'
      required:
        - hostname
        - cluster_name
        - state
        - observed_addresses
        - expected_addresses
      type: object
    CustomDNSRequiredRecord:
      properties:
        name:
          type: string
        type:
          type: string
        value:
          type: string
      required:
        - name
        - type
        - value
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````