Domains Reference

All endpoints for managing forward and reverse zones. For the conceptual model, see Zones and Records. For task walkthroughs, see Managing Domains.

Base path: /api/v1/domains/

GET /api/v1/domains/#

List zones in the current tenant.

Query parameters:

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
  "data": [
    {
      "id": "d_abc123",
      "name": "example.com",
      "domain_type": "primary",
      "status": "active",
      "default_ttl": 3600,
      "description": "Main production zone",
      "dnssec_enabled": true,
      "created_at": "2026-04-01T10:00:00Z",
      "updated_at": "2026-04-15T14:30:00Z"
    }
  ],
  "total": 42,
  "page": 1,
  "page_size": 50,
  "total_pages": 1
}

POST /api/v1/domains/#

Create a zone.

Request:

Response: DomainDetailResponse (see schema below).

Status: pending_validation initially. Records are stored but not served.

GET /api/v1/domains/{domain_id}#

Get a single zone.

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "id": "d_abc123",
  "name": "example.com",
  "domain_type": "primary",
  "status": "active",
  "default_ttl": 3600,
  "description": "Main production zone",
  "dnssec_enabled": true,
  "pdns_zone_id": "example.com.",
  "tenant_id": "t_xyz789",
  "settings": {},
  "created_at": "2026-04-01T10:00:00Z",
  "updated_at": "2026-04-15T14:30:00Z",
  "deleted_at": null,
  "record_count": 17,
  "current_validation": null
}

PATCH /api/v1/domains/{domain_id}#

Update zone metadata. Only description, default_ttl, and settings are editable.

Request:

Response: Updated zone.

DELETE /api/v1/domains/{domain_id}#

Delete a zone. Soft by default (recoverable); add ?hard=true for permanent deletion.

Response: 204 No Content.

POST /api/v1/domains/{domain_id}/restore#

Restore a soft-deleted zone.

Response: Zone with status set back to its prior value.

GET /api/v1/domains/{domain_id}/soa#

Get the zone's SOA record in a structured shape.

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "primary_ns": "ns1.scaidns.scailabs.ai.",
  "hostmaster": "hostmaster.example.com.",
  "serial": 2026042301,
  "refresh": 3600,
  "retry": 600,
  "expire": 604800,
  "minimum": 600,
  "ttl": 3600
}

GET /api/v1/domains/{domain_id}/export#

Export zone as BIND format. See Import and Export.

Response:

1
2
3
4
5
6

{
  "domain_id": "d_abc123",
  "domain_name": "example.com",
  "format": "bind",
  "zone_file": "..."
}

Validation sub-resource#

See Domain Validation for /validation endpoints under each domain.

Records sub-resource#

See Records for /records/* endpoints under each domain.

DNSSEC sub-resource#

See DNSSEC for /dnssec/* endpoints under each domain.

Access grants sub-resource#

See Access Grants for /access-grants/* endpoints under each domain.

Schemas#

DomainResponse#

DomainDetailResponse#

Everything in DomainResponse plus:

Error codes#

Related#

• Managing Domains — task-oriented guide.
• Records — record CRUD.
• Domain Validation — ownership proof.