Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Domains.domain Dns Record API

The domains.domainDnsRecord API from Microsoft Entra ID (formerly Azure AD) — 6 operation(s) for domains.domaindnsrecord.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /domains/{domain-id}/serviceConfigurationRecords List DNS records needed to enable services on a domain · List serviceConfigurationRecords #
Ask an LLM
“Which DNS records do I need to add to my zone file so Microsoft Online services work on my domain?”
“What MX, CNAME and TXT records does a custom domain need for email and other services?”
Tell an agent
List the service configuration DNS records for domain {domain}.
Show which records I must add to the zone of {domain} to enable services.
POST /domains/{domain-id}/serviceConfigurationRecords Add a service configuration record to a domain · Create new navigation property to serviceConfigurationRecords for domains #
Ask an LLM
“Can I add a new service configuration DNS record entry to a domain?”
“What fields go into a service configuration record, such as label, type, service and TTL?”
Tell an agent
Add a {type} service configuration record labelled {label} to domain {domain}.
Create a service configuration record on {domain} for service {service} with TTL {ttl}.
GET /domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id} Get one service configuration record of a domain · Get serviceConfigurationRecords from domains #
Ask an LLM
“What are the details of one specific service configuration DNS record for my domain?”
“Is a particular service configuration record optional for the domain?”
Tell an agent
Get service configuration record {record} for domain {domain}.
Show the label, type and TTL of service record {record} on {domain}.
PATCH /domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id} Update a service configuration record of a domain · Update the navigation property serviceConfigurationRecords in domains #
Ask an LLM
“Can I change the TTL or label of an existing service configuration record?”
“Which properties of a domain's service configuration record can be edited?”
Tell an agent
Set the TTL of service configuration record {record} on {domain} to {ttl}.
Mark service record {record} on domain {domain} as optional {optional}.
DELETE /domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id} Delete a service configuration record from a domain · Delete navigation property serviceConfigurationRecords for domains #
Ask an LLM
“Can I remove a service configuration DNS record entry from a domain?”
“What happens if I delete one of a domain's service configuration records?”
Tell an agent destructive · confirm first
Delete service configuration record {record} from domain {domain}.
Remove the services DNS record {record} on {domain}.
GET /domains/{domain-id}/serviceConfigurationRecords/$count Count a domain's service configuration records · Get the number of the resource #
Ask an LLM
“How many service configuration DNS records does my domain require?”
“What is the total of services records for a custom domain?”
Tell an agent
Count the service configuration records for domain {domain}.
Tell me how many services DNS records {domain} has.
GET /domains/{domain-id}/verificationDnsRecords List DNS records needed to verify domain ownership · List verificationDnsRecords #
Ask an LLM
“Which DNS record do I add to prove I own a custom domain before using it in my tenant?”
“Why can't I use my new domain yet, and what verification records does it need?”
Tell an agent
List the ownership verification DNS records for domain {domain}.
Show the TXT or MX record I need to add to verify {domain}.
POST /domains/{domain-id}/verificationDnsRecords Add a verification record to a domain · Create new navigation property to verificationDnsRecords for domains #
Ask an LLM
“Can I add a new ownership verification DNS record entry to a domain?”
“What fields describe a verification record, such as its type, label and TTL?”
Tell an agent
Add a {type} verification record labelled {label} to domain {domain}.
Create a domain verification record on {domain} with TTL {ttl}.
GET /domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id} Get one verification record of a domain · Get verificationDnsRecords from domains #
Ask an LLM
“What exactly does one of my domain's ownership verification records say?”
“Which label and value should I copy into my DNS host to verify the domain?”
Tell an agent
Get verification record {record} for domain {domain}.
Show the type, label and TTL of verification record {record} on {domain}.
PATCH /domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id} Update a verification record of a domain · Update the navigation property verificationDnsRecords in domains #
Ask an LLM
“Can I change the TTL or label on an existing domain verification record?”
“Which properties of a verification DNS record can be edited after it exists?”
Tell an agent
Set the TTL of verification record {record} on {domain} to {ttl}.
Change the label of verification record {record} on domain {domain} to {label}.
DELETE /domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id} Delete a verification record from a domain · Delete navigation property verificationDnsRecords for domains #
Ask an LLM
“Can I remove an ownership verification DNS record entry from a domain?”
“Is it possible to delete a verification record I no longer need?”
Tell an agent destructive · confirm first
Delete verification record {record} from domain {domain}.
Remove the ownership verification DNS entry {record} on {domain}.
GET /domains/{domain-id}/verificationDnsRecords/$count Count a domain's verification records · Get the number of the resource #
Ask an LLM
“How many ownership verification records exist for a domain?”
“What is the total of verification DNS entries for a custom domain?”
Tell an agent
Count the verification records for domain {domain}.
Tell me how many verification DNS records {domain} has.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
Documentation
https://learn.microsoft.com/en-us/graph/change-notifications-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/openapi/azure-ad-domains-domaindnsrecord-api-openapi.yml

Other Resources

🔗
SDKs
https://learn.microsoft.com/en-us/graph/sdks/sdks-overview
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/asyncapi/azure-ad-change-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-domains-domaindnsrecord-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ad-domains-domaindnsrecord-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Identity.DirectoryManagement Domains.domain Dns Record API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: domains.domainDnsRecord
paths:
  /domains/{domain-id}/serviceConfigurationRecords:
    get:
      tags:
      - domains.domainDnsRecord
      summary: List serviceConfigurationRecords
      description: Retrieves a list of domainDnsRecord objects needed to enable services for the domain. Use the returned list to add records to the zone file of the domain. This can be done through the domain registrar or DNS server configuration.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/domain-list-serviceconfigurationrecords?view=graph-rest-1.0
      operationId: domain_ListServiceConfigurationRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.domainDnsRecordCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - domains.domainDnsRecord
      summary: Create new navigation property to serviceConfigurationRecords for domains
      operationId: domain_CreateServiceConfigurationRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}:
    get:
      tags:
      - domains.domainDnsRecord
      summary: Get serviceConfigurationRecords from domains
      description: DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Doesn't support $expand.
      operationId: domain_GetServiceConfigurationRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - name: domainDnsRecord-id
        in: path
        description: The unique identifier of domainDnsRecord
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domainDnsRecord
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - domains.domainDnsRecord
      summary: Update the navigation property serviceConfigurationRecords in domains
      operationId: domain_UpdateServiceConfigurationRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - name: domainDnsRecord-id
        in: path
        description: The unique identifier of domainDnsRecord
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domainDnsRecord
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - domains.domainDnsRecord
      summary: Delete navigation property serviceConfigurationRecords for domains
      operationId: domain_DeleteServiceConfigurationRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - name: domainDnsRecord-id
        in: path
        description: The unique identifier of domainDnsRecord
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domainDnsRecord
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /domains/{domain-id}/serviceConfigurationRecords/$count:
    get:
      tags:
      - domains.domainDnsRecord
      summary: Get the number of the resource
      operationId: domain.serviceConfigurationRecord_GetCount
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
  /domains/{domain-id}/verificationDnsRecords:
    get:
      tags:
      - domains.domainDnsRecord
      summary: List verificationDnsRecords
      description: Retrieve a list of domainDnsRecord objects. You cannot use an associated domain with your Microsoft Entra tenant until ownership is verified. To verify the ownership of the domain, retrieve the domain verification records and add the details to the zone file of the domain. This can be done through the domain registrar or DNS server configuration. Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/domain-list-verificationdnsrecords?view=graph-rest-1.0
      operationId: domain_ListVerificationDnsRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.domainDnsRecordCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - domains.domainDnsRecord
      summary: Create new navigation property to verificationDnsRecords for domains
      operationId: domain_CreateVerificationDnsRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}:
    get:
      tags:
      - domains.domainDnsRecord
      summary: Get verificationDnsRecords from domains
      description: DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Doesn't support $expand.
      operationId: domain_GetVerificationDnsRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - name: domainDnsRecord-id
        in: path
        description: The unique identifier of domainDnsRecord
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domainDnsRecord
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - domains.domainDnsRecord
      summary: Update the navigation property verificationDnsRecords in domains
      operationId: domain_UpdateVerificationDnsRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - name: domainDnsRecord-id
        in: path
        description: The unique identifier of domainDnsRecord
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domainDnsRecord
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - domains.domainDnsRecord
      summary: Delete navigation property verificationDnsRecords for domains
      operationId: domain_DeleteVerificationDnsRecord
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - name: domainDnsRecord-id
        in: path
        description: The unique identifier of domainDnsRecord
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domainDnsRecord
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /domains/{domain-id}/verificationDnsRecords/$count:
    get:
      tags:
      - domains.domainDnsRecord
      summary: Get the number of the resource
      operationId: domain.verificationDnsRecord_GetCount
      parameters:
      - name: domain-id
        in: path
        description: The unique identifier of domain
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: domain
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    microsoft.graph.domainDnsRecordCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.domainDnsRecordCollectionResponse'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
  schemas:
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.domainDnsRecordCollectionResponse:
      title: Collection of domainDnsRecord
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.domainDnsRecord:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: domainDnsRecord
        type: object
        properties:
          isOptional:
            type: boolean
            description: If false, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain.
          label:
            type: string
            description: Value used when configuring the name of the DNS record at the DNS host.
          recordType:
            type:
            - string
            - 'null'
            description: Indicates what type of DNS record this entity represents. The value can be CName, Mx, Srv, or Txt.
          supportedService:
            type: string
            description: 'Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune.'
          ttl:
            maximum: 2147483647
            minimum: -2147483648
            type: number
            description: Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable.
            format: int32
        additionalProperties:
          type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
  parameters:
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}