Vorynza
Vorynza
DashboardPricingDocumentation
API referencePostgres APIMail APIDNS API
API

DNS API

REST API endpoints for managing DNS zones, records, security gateway, and custom domains.

Endpoints for managing DNS zones and records within your project.

Zones

List zones

GET /api/orgs/:orgSlug/projects/:projectSlug/dns/zones

Create a zone

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/zones
FieldTypeRequiredDescription
domainstringyesThe domain name
modestringyesfull_hosting or external
customNameserversstring[]noCustom NS records

Scan a domain

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/scan

Discovers current NS records and existing DNS records for a domain.

Get a zone

GET /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId

Delete a zone

DELETE /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId

Verify nameservers

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/verify

Sync zone

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/sync

Records

List records

GET /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/records

Create a record

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/records
FieldTypeRequiredDescription
typestringyesA, AAAA, CNAME, MX, TXT, NS, CAA
namestringyesRecord name relative to zone
valuestringyesRecord value
ttlnumbernoTTL in seconds (default 300)
prioritynumbernoMX priority
proxiedbooleannoEnable proxy (A, AAAA, CNAME only)
originProtocolstringnohttp or https
originPortnumbernoOrigin port
originPathstringnoOrigin path
originHostHeaderstringnoOrigin host header

Update a record

PATCH /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/records/:recordId

Partial update — at least one field required.

Delete a record

DELETE /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/records/:recordId

Bulk delete records

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/records/bulk-delete
{
  "recordIds": ["id1", "id2", ...]
}

Max 100 records per request.

Restore a record

POST /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/records/:recordId/restore

Security gateway

Get policy

GET /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/security-gateway

Update policy

PUT /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/security-gateway

List events

GET /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/security-gateway/events

Event summary

GET /api/orgs/:orgSlug/projects/:projectSlug/dns/zones/:zoneId/security-gateway/summary?hours=24

API key access

List zones (API key)

GET /api/dns/zones
Authorization: Bearer <api-key>

Requires dns:read scope.

List records (API key)

GET /api/dns/zones/:zoneId/records
Authorization: Bearer <api-key>

Requires dns:read scope.

Need help? Contact support.

Mail API

REST API endpoints for sending email and managing mail services, domains, and API keys.

On this page

ZonesList zonesCreate a zoneScan a domainGet a zoneDelete a zoneVerify nameserversSync zoneRecordsList recordsCreate a recordUpdate a recordDelete a recordBulk delete recordsRestore a recordSecurity gatewayGet policyUpdate policyList eventsEvent summaryAPI key accessList zones (API key)List records (API key)