Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Netlify dnsZone API

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

Netlify dnsZone API is one of 35 APIs that Netlify publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include dnsZone. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and a getting-started guide.

This API exposes 11 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 2.33.1.

Requests are made against a single base URL, https://api.netlify.com/api/v1.

11 operations 6 paths 7 schemas 2 DELETE5 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.33.1
Base URL
https://api.netlify.com/api/v1/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Netlify dnsZone API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (netlifyAuth) using the implicit flow. By default, every request must be authenticated.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

dnsZone 11
GET
/sites/{site_id}/dns
getDNSForSite 1 param → 200default
PUT
/sites/{site_id}/dns
configureDNSForSite 1 param → 200default
GET
/dns_zones
getDnsZones 1 param → 200default
POST
/dns_zones
createDnsZone body → 201default
GET
/dns_zones/{zone_id}
getDnsZone 1 param → 200default
DELETE
/dns_zones/{zone_id}
deleteDnsZone 1 param → 204default
PUT
/dns_zones/{zone_id}/transfer
transferDnsZone 4 params → 200default
GET
/dns_zones/{zone_id}/dns_records
getDnsRecords 1 param → 200default
POST
/dns_zones/{zone_id}/dns_records
createDnsRecord 1 param body → 201default
GET
/dns_zones/{zone_id}/dns_records/{dns_record_id}
getIndividualDnsRecord 2 params → 200default
DELETE
/dns_zones/{zone_id}/dns_records/{dns_record_id}
deleteDnsRecord 2 params → 204default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are dnsZone (16 properties), dnsRecord (11 properties), dnsRecordCreate (9 properties), dnsZoneSetup (3 properties). Each schema is shown below with its type and property counts.

dnsZone
object
16 properties
dnsZones
array
dnsZoneSetup
object
3 properties
dnsRecord
object
11 properties
dnsRecords
array
dnsRecordCreate
object
9 properties
error
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netlify-dnszone-api-openapi.yml Raw ↑

Other APIs Netlify publishes across the network.

Netlify accessToken API
Netlify accountMembership API
Netlify accountType API
Netlify Asset API
Netlify assetPublicSignature API
Netlify auditLog API
Netlify Build API
Netlify buildHook API
Netlify buildLogMsg API
Netlify Deploy API
Netlify deployedBranch API
Netlify deployKey API