Zones

A zone is a domain hosted on the Quathos Monitor authoritative nameservers. You create it, point your registrar at the assigned nameservers, and the zone becomes active once delegation is detected.

Lifecycle

pending — created on our nameservers, waiting for the registrar to point at them.
active — all observed public NS point to Quathos Monitor; the zone is live.
Delegation is re-checked every 5 minutes. If it is lost, the zone goes back to pending and the organization owner is notified by e-mail.

The zone object

Field	Type	Description
`id`	integer	Unique identifier of the zone.
`org_id`	integer	Organization that owns the zone.
`name`	string	Apex domain, normalized to lowercase without trailing dot (e.g. example.com).
`status`	enum	initializing · pending · active · moved · deleted. New zones start as pending.
`nameservers`	string[] \| null	Nameservers assigned to the zone (ns1.qflaryx.com, ns2.qflaryx.com).
`dnssec_enabled`	boolean	Whether the zone is signed with DNSSEC.
`checked_at`	datetime \| null	Last time delegation was checked (UTC).
`created_at`	datetime	Creation timestamp (UTC).

Create a zone

POST /orgs/{org_id}/zones

Creates the zone on the authoritative nameservers and returns it in pending with the assigned nameservers.

Body parameters

Parameter	Type	Description
`name` required	string	Apex domain, 3–253 characters. Normalized to lowercase; must contain a dot and no spaces.

Example

curl -X POST 'https://api.qflaryx.com/v1/orgs/$ORG_ID/zones' \
  -H 'Authorization: Bearer $QFLARYX_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "example.com" }'

Requirements

Your account e-mail must be verified (403 otherwise), and each domain can exist only once across Quathos Monitor — a duplicate returns 409 "Domínio já cadastrado".

List & retrieve

GET /orgs/{org_id}/zones

Lists the organization's zones, ordered by name.

GET /orgs/{org_id}/zones/{zone_id}

Returns a single zone, or 404 if it doesn't exist in your organization.

Setup instructions

GET /orgs/{org_id}/zones/{zone_id}/setup

Activation helper: the nameservers assigned to the zone (assigned_ns), the ones the public DNS currently reports (current_ns), whether delegation already points to Quathos Monitor (delegated) and step-by-step instructions.

curl 'https://api.qflaryx.com/v1/orgs/$ORG_ID/zones/42/setup' \
  -H 'Authorization: Bearer $QFLARYX_KEY'

Import records

POST /orgs/{org_id}/zones/{zone_id}/import

Bring existing records into the zone. Provide either a BIND zone file or ask for a quick scan of common names at your current provider. Records that fail validation, exceed the plan limit or already exist are skipped, not imported.

Body parameters

Parameter	Type	Description
`bind_file`	string	Contents of a BIND zone file to parse and import.
`quick_scan`	boolean	Alternatively, probe common names (apex, www, mail…) at the current provider and import what is found.

One of the two is required

Send bind_file or "quick_scan": true. Omitting both — or sending an unparseable zone file — returns 422.

A quick scan is never complete

The DNS gives no way to list a zone from the outside, so the scan probes likely names instead of enumerating them. Records under custom names — DKIM selectors tied to an account id, for instance — can be missed. The response carries a warnings array describing what may be absent; show it to the user before they repoint their nameservers. A BIND file exported from the current provider is the only complete path.

Example

curl -X POST 'https://api.qflaryx.com/v1/orgs/$ORG_ID/zones/42/import' \
  -H 'Authorization: Bearer $QFLARYX_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "bind_file": "$ORIGIN example.com.\nwww 3600 IN A 203.0.113.10\n..." }'

Check delegation

POST /orgs/{org_id}/zones/{zone_id}/check-delegation

Re-checks the public NS of the domain on demand and updates the zone status: pending → active when every observed nameserver is ours, active → pending if delegation was lost. Returns the updated zone object with a fresh checked_at.

cURL

curl -X POST \
  'https://api.qflaryx.com/v1/orgs/$ORG_ID/zones/42/check-delegation' \
  -H 'Authorization: Bearer $QFLARYX_KEY'

Delete a zone

DELETE /orgs/{org_id}/zones/{zone_id}

Removes the zone from the authoritative nameservers and deletes it — records included. Returns 204 No Content.

cURL

curl -X DELETE 'https://api.qflaryx.com/v1/orgs/$ORG_ID/zones/42' \
  -H 'Authorization: Bearer $QFLARYX_KEY'

Irreversible

Deleting a zone that is still delegated to Quathos Monitor takes the domain offline. Move the delegation away first, then delete.

Previous Errors Next Records