API DNS

• 200 All zones (not paginated; meta.total = count) data[]: uuiddomainstatusnameserversproxy_enableddnssec_enabledlast_ns_checkcreated_atupdated_at
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:read (details.required_scope)
• 429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

domain string

الزامی Apex domain, e.g. example.com (lower-cased)

• 201 Zone created with status pending; set the returned nameservers at your registrar — records can be added once the zone is verified data: uuiddomainstatusnameserversproxy_enableddnssec_enabledlast_ns_checkcreated_atupdated_at
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:write (details.required_scope)
• 409 conflict — the domain already exists
• 422 validation_failed — invalid domain
• 429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

• 200 Zone detail data: uuiddomainstatusnameserversproxy_enableddnssec_enabledlast_ns_checkcreated_atupdated_at
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:read (details.required_scope)
• 404 not_found — unknown zone
• 429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

• 200 BIND zonefile data: domainformatzonefile
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:read (details.required_scope)
• 404 not_found — unknown zone
• 429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

• 200 Deleted data: deleted
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:write (details.required_scope)
• 404 not_found — unknown zone
• 429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

type string

اختیاری Filter by record type (case-insensitive): A | AAAA | CNAME | MX | TXT | NS | SRV | CAA

• 200 All matching records (not paginated; meta.total = count) data[]: idtypenamecontentttlpriorityproxy_enabledcreated_atupdated_at
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:read (details.required_scope)
• 404 not_found — unknown zone
• 429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

type string

الزامی one of: A | AAAA | CNAME | MX | TXT | NS | SRV | CAA

name string

اختیاری Subdomain label, or @ for the apex — default: @

content string

الزامی Record value (IP, hostname, text …)

ttl integer

اختیاری 1 (or less) = Auto; other values are clamped to 60-86400 — default: 3600

priority integer | null

اختیاری For MX/SRV

proxy_enabled boolean

اختیاری Route through the CDN (A/AAAA/in-zone CNAME); usually set later via PATCH /api/v1/edge/records/{rid} — default: false

• 201 Record created data: idtypenamecontentttlpriorityproxy_enabledcreated_atupdated_at
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:write (details.required_scope)
• 404 not_found — unknown zone
• 409 conflict — zone not verified yet (nameservers not set at the registrar)
• 422 validation_failed — invalid type/name/content/priority, name too long, or conflicts with an existing record (e.g. CNAME next to other records)
• 429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

rid integer

الزامی Record id (id from the record list)

All fields optional; omitted fields keep their value

content string

اختیاری

ttl integer

اختیاری 1 (or less) = Auto; other values are clamped to 60-86400

priority integer | null

اختیاری

proxy_enabled boolean

اختیاری

• 200 Updated record data: idtypenamecontentttlpriorityproxy_enabledcreated_atupdated_at
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:write (details.required_scope)
• 404 not_found — unknown zone or record
• 422 validation_failed — invalid content/priority
• 429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)

uuid string

الزامی Zone UUID

rid integer

الزامی Record id

• 200 Deleted data: deleted
• 401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
• 403 scope_missing — the token lacks dns:write (details.required_scope)
• 404 not_found — unknown zone or record
• 429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)