Netlify

Netlify Dns Zone API

The dnsZone API from Netlify — 6 operation(s) for dnszone.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 11

GET /sites/{site_id}/dns Get DNS for site #
PUT /sites/{site_id}/dns Configure DNS for site #
POST /dns_zones Create dns zone #
GET /dns_zones Get dns zones #
GET /dns_zones/{zone_id} Get dns zone #
DELETE /dns_zones/{zone_id} Delete dns zone #
PUT /dns_zones/{zone_id}/transfer Transfer dns zone #
GET /dns_zones/{zone_id}/dns_records Get dns records #
POST /dns_zones/{zone_id}/dns_records Create dns record #
GET /dns_zones/{zone_id}/dns_records/{dns_record_id} Get individual dns record #
DELETE /dns_zones/{zone_id}/dns_records/{dns_record_id} Delete dns record #

Documentation

📖
Documentation
https://open-api.netlify.com/
📖
GettingStarted
https://docs.netlify.com/api-and-cli-guides/api-guides/get-started-with-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/openapi/netlify-dnszone-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/asyncapi/netlify-webhooks-asyncapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/overlays/netlify-dnszone-overlay.yaml
🔗
API Guides
https://docs.netlify.com/api-and-cli-guides/overview/
🔗
OpenAPI Source
https://github.com/netlify/open-api
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/graphql/netlify-graphql.md

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/netlify-dnszone-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

netlify-dnszone-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.57.0
  title: Netlify's API documentation Dns Zone API
  description: Netlify is a hosting service for the programmable web.
  termsOfService: https://www.netlify.com/legal/terms-of-use/
  x-logo:
    url: netlify-logo.png
    href: https://www.netlify.com/docs/
    altText: Netlify
servers:
- url: https://api.netlify.com/api/v1
security:
- netlifyAuth: []
tags:
- name: dnsZone
  x-displayName: DNS zone
paths:
  /sites/{site_id}/dns:
    parameters:
    - name: site_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getDNSForSite
      tags:
      - dnsZone
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    errors:
                      type: array
                      items:
                        type: string
                    supported_record_types:
                      type: array
                      items:
                        type: string
                    user_id:
                      type: string
                    created_at:
                      type: string
                      format: dateTime
                    updated_at:
                      type: string
                      format: dateTime
                    records:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          hostname:
                            type: string
                          type:
                            type: string
                          value:
                            type: string
                          ttl:
                            type: integer
                            format: int64
                          priority:
                            type: integer
                            format: int64
                          dns_zone_id:
                            type: string
                          site_id:
                            type: string
                          flag:
                            type: integer
                          tag:
                            type: string
                          managed:
                            type: boolean
                    dns_servers:
                      type: array
                      items:
                        type: string
                    account_id:
                      type: string
                    site_id:
                      type: string
                    account_slug:
                      type: string
                    account_name:
                      type: string
                    domain:
                      type: string
                    ipv6_enabled:
                      type: boolean
                    dedicated:
                      type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get DNS for site
      x-summary-source: derived
    put:
      operationId: configureDNSForSite
      tags:
      - dnsZone
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    errors:
                      type: array
                      items:
                        type: string
                    supported_record_types:
                      type: array
                      items:
                        type: string
                    user_id:
                      type: string
                    created_at:
                      type: string
                      format: dateTime
                    updated_at:
                      type: string
                      format: dateTime
                    records:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          hostname:
                            type: string
                          type:
                            type: string
                          value:
                            type: string
                          ttl:
                            type: integer
                            format: int64
                          priority:
                            type: integer
                            format: int64
                          dns_zone_id:
                            type: string
                          site_id:
                            type: string
                          flag:
                            type: integer
                          tag:
                            type: string
                          managed:
                            type: boolean
                    dns_servers:
                      type: array
                      items:
                        type: string
                    account_id:
                      type: string
                    site_id:
                      type: string
                    account_slug:
                      type: string
                    account_name:
                      type: string
                    domain:
                      type: string
                    ipv6_enabled:
                      type: boolean
                    dedicated:
                      type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Configure DNS for site
      x-summary-source: derived
  /dns_zones:
    post:
      operationId: createDnsZone
      tags:
      - dnsZone
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  supported_record_types:
                    type: array
                    items:
                      type: string
                  user_id:
                    type: string
                  created_at:
                    type: string
                    format: dateTime
                  updated_at:
                    type: string
                    format: dateTime
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        hostname:
                          type: string
                        type:
                          type: string
                        value:
                          type: string
                        ttl:
                          type: integer
                          format: int64
                        priority:
                          type: integer
                          format: int64
                        dns_zone_id:
                          type: string
                        site_id:
                          type: string
                        flag:
                          type: integer
                        tag:
                          type: string
                        managed:
                          type: boolean
                  dns_servers:
                    type: array
                    items:
                      type: string
                  account_id:
                    type: string
                  site_id:
                    type: string
                  account_slug:
                    type: string
                  account_name:
                    type: string
                  domain:
                    type: string
                  ipv6_enabled:
                    type: boolean
                  dedicated:
                    type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_slug:
                  type: string
                site_id:
                  type: string
                name:
                  type: string
        required: true
      summary: Create dns zone
      x-summary-source: derived
    get:
      operationId: getDnsZones
      tags:
      - dnsZone
      parameters:
      - name: account_slug
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: get all DNS zones the user has access to
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    errors:
                      type: array
                      items:
                        type: string
                    supported_record_types:
                      type: array
                      items:
                        type: string
                    user_id:
                      type: string
                    created_at:
                      type: string
                      format: dateTime
                    updated_at:
                      type: string
                      format: dateTime
                    records:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          hostname:
                            type: string
                          type:
                            type: string
                          value:
                            type: string
                          ttl:
                            type: integer
                            format: int64
                          priority:
                            type: integer
                            format: int64
                          dns_zone_id:
                            type: string
                          site_id:
                            type: string
                          flag:
                            type: integer
                          tag:
                            type: string
                          managed:
                            type: boolean
                    dns_servers:
                      type: array
                      items:
                        type: string
                    account_id:
                      type: string
                    site_id:
                      type: string
                    account_slug:
                      type: string
                    account_name:
                      type: string
                    domain:
                      type: string
                    ipv6_enabled:
                      type: boolean
                    dedicated:
                      type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get dns zones
      x-summary-source: derived
  /dns_zones/{zone_id}:
    parameters:
    - name: zone_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getDnsZone
      tags:
      - dnsZone
      responses:
        '200':
          description: get a single DNS zone
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  supported_record_types:
                    type: array
                    items:
                      type: string
                  user_id:
                    type: string
                  created_at:
                    type: string
                    format: dateTime
                  updated_at:
                    type: string
                    format: dateTime
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        hostname:
                          type: string
                        type:
                          type: string
                        value:
                          type: string
                        ttl:
                          type: integer
                          format: int64
                        priority:
                          type: integer
                          format: int64
                        dns_zone_id:
                          type: string
                        site_id:
                          type: string
                        flag:
                          type: integer
                        tag:
                          type: string
                        managed:
                          type: boolean
                  dns_servers:
                    type: array
                    items:
                      type: string
                  account_id:
                    type: string
                  site_id:
                    type: string
                  account_slug:
                    type: string
                  account_name:
                    type: string
                  domain:
                    type: string
                  ipv6_enabled:
                    type: boolean
                  dedicated:
                    type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get dns zone
      x-summary-source: derived
    delete:
      operationId: deleteDnsZone
      tags:
      - dnsZone
      responses:
        '204':
          description: delete a single DNS zone
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Delete dns zone
      x-summary-source: derived
  /dns_zones/{zone_id}/transfer:
    parameters:
    - name: zone_id
      in: path
      required: true
      schema:
        type: string
    - name: account_id
      in: query
      description: the account of the dns zone
      required: true
      schema:
        type: string
    - name: transfer_account_id
      in: query
      description: the account you want to transfer the dns zone to
      required: true
      schema:
        type: string
    - name: transfer_user_id
      in: query
      description: the user you want to transfer the dns zone to
      required: true
      schema:
        type: string
    put:
      operationId: transferDnsZone
      tags:
      - dnsZone
      responses:
        '200':
          description: transfer a DNS zone to another account
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  supported_record_types:
                    type: array
                    items:
                      type: string
                  user_id:
                    type: string
                  created_at:
                    type: string
                    format: dateTime
                  updated_at:
                    type: string
                    format: dateTime
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        hostname:
                          type: string
                        type:
                          type: string
                        value:
                          type: string
                        ttl:
                          type: integer
                          format: int64
                        priority:
                          type: integer
                          format: int64
                        dns_zone_id:
                          type: string
                        site_id:
                          type: string
                        flag:
                          type: integer
                        tag:
                          type: string
                        managed:
                          type: boolean
                  dns_servers:
                    type: array
                    items:
                      type: string
                  account_id:
                    type: string
                  site_id:
                    type: string
                  account_slug:
                    type: string
                  account_name:
                    type: string
                  domain:
                    type: string
                  ipv6_enabled:
                    type: boolean
                  dedicated:
                    type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Transfer dns zone
      x-summary-source: derived
  /dns_zones/{zone_id}/dns_records:
    parameters:
    - name: zone_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getDnsRecords
      tags:
      - dnsZone
      responses:
        '200':
          description: get all DNS records for a single DNS zone
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    hostname:
                      type: string
                    type:
                      type: string
                    value:
                      type: string
                    ttl:
                      type: integer
                      format: int64
                    priority:
                      type: integer
                      format: int64
                    dns_zone_id:
                      type: string
                    site_id:
                      type: string
                    flag:
                      type: integer
                    tag:
                      type: string
                    managed:
                      type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get dns records
      x-summary-source: derived
    post:
      operationId: createDnsRecord
      tags:
      - dnsZone
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  hostname:
                    type: string
                  type:
                    type: string
                  value:
                    type: string
                  ttl:
                    type: integer
                    format: int64
                  priority:
                    type: integer
                    format: int64
                  dns_zone_id:
                    type: string
                  site_id:
                    type: string
                  flag:
                    type: integer
                  tag:
                    type: string
                  managed:
                    type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                hostname:
                  type: string
                value:
                  type: string
                ttl:
                  type: integer
                  format: int64
                priority:
                  type: integer
                  format: int64
                weight:
                  type: integer
                  format: int64
                port:
                  type: integer
                  format: int64
                flag:
                  type: integer
                  format: int64
                tag:
                  type: string
        required: true
      summary: Create dns record
      x-summary-source: derived
  /dns_zones/{zone_id}/dns_records/{dns_record_id}:
    parameters:
    - name: zone_id
      in: path
      required: true
      schema:
        type: string
    - name: dns_record_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getIndividualDnsRecord
      tags:
      - dnsZone
      responses:
        '200':
          description: get a single DNS record
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  hostname:
                    type: string
                  type:
                    type: string
                  value:
                    type: string
                  ttl:
                    type: integer
                    format: int64
                  priority:
                    type: integer
                    format: int64
                  dns_zone_id:
                    type: string
                  site_id:
                    type: string
                  flag:
                    type: integer
                  tag:
                    type: string
                  managed:
                    type: boolean
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get individual dns record
      x-summary-source: derived
    delete:
      operationId: deleteDnsRecord
      tags:
      - dnsZone
      responses:
        '204':
          description: record deleted
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Delete dns record
      x-summary-source: derived
components:
  securitySchemes:
    netlifyAuth:
      type: oauth2
      flows:
        implicit:
          scopes: {}
          authorizationUrl: https://app.netlify.com/authorize
externalDocs:
  url: https://www.netlify.com/docs/api/
  description: Online documentation
x-tagGroups:
- name: OAuth
  tags:
  - ticket
  - accessToken
- name: User accounts
  tags:
  - user
  - accountMembership
  - member
  - accountType
  - paymentMethod
  - auditLog
- name: Site
  tags:
  - site
  - environmentVariables
  - file
  - metadata
  - purge
  - snippet
- name: Domain names
  tags:
  - dnsZone
  - sniCertificate
- name: Deploys
  tags:
  - deploy
  - deployedBranch
  - deployKey
- name: Builds
  tags:
  - build
  - buildLogMsg
- name: Dev servers
  tags:
  - devServer
- name: Webhooks and notifications
  tags:
  - hook
  - hookType
  - buildHook
  - devServerHook
- name: Services
  tags:
  - service
  - serviceInstance
- name: Functions
  tags:
  - function
- name: Database
  tags:
  - database
- name: Forms
  tags:
  - form
  - submission
- name: Split tests
  tags:
  - splitTest
- name: Large media
  tags:
  - asset
  - assetPublicSignature