API & development

DNS zone and record data fields

Exact JSON field names and types, with public-request versus protected-state boundaries.

Platform: Go
Technology: Go

How to use these fields

This release-matched technical reference indexes the JSON-visible fields in the reviewed typed models. Start with the operational guide and API conventions. A model is not a public mutation schema: request structs, response records, protected plans and internal receipts serve different purposes. Submit only the fields supported by the exact endpoint/client; unknown fields are rejected. Internal sequence, signature, receipt, owner and generation values cannot be edited to grant authority. Optional means a Go JSON field can be omitted when empty; it does not waive an endpoint prerequisite. Values containing credentials/secrets must use the protected write-only form, never logs, query strings or support screenshots. Current account ownership, grants, feature/licence state and capability still apply.

CreateRequest

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`zone_name`	`string`	Encoded by this model
`mode`	`string`	Encoded by this model
`default_ttl`	`uint32`	Encoded by this model
`soa`	`lifecycle.SOA`	Encoded by this model
`records`	`[]lifecycle.Record`	Encoded by this model
`dnssec`	`bool`	Encoded by this model
`template_id`	`string`	Optional when empty

ModifyRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`zone_name`	`string`	Encoded by this model
`mode`	`string`	Encoded by this model
`default_ttl`	`uint32`	Encoded by this model
`soa`	`lifecycle.SOA`	Encoded by this model
`records`	`[]lifecycle.Record`	Encoded by this model
`dnssec`	`bool`	Encoded by this model
`template_id`	`string`	Optional when empty

ChangeRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model

ImportRequest

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`zone_name`	`string`	Optional when empty
`mode`	`string`	Encoded by this model
`dnssec`	`bool`	Encoded by this model
`zone_file`	`string`	Encoded by this model

TemplateRecord

JSON field	Type	Presence
`name`	`string`	Encoded by this model
`type`	`string`	Encoded by this model
`ttl`	`uint32`	Optional when empty
`address`	`string`	Optional when empty
`target`	`string`	Optional when empty
`text`	`[]string`	Optional when empty
`priority`	`uint16`	Optional when empty
`weight`	`uint16`	Optional when empty
`port`	`uint16`	Optional when empty
`flags`	`uint8`	Optional when empty
`tag`	`string`	Optional when empty
`value`	`string`	Optional when empty

TemplateSpec

JSON field	Type	Presence
`name`	`string`	Encoded by this model
`account_id`	`string`	Optional when empty
`default_ttl`	`uint32`	Encoded by this model
`refresh`	`uint32`	Encoded by this model
`retry`	`uint32`	Encoded by this model
`expire`	`uint32`	Encoded by this model
`negative_ttl`	`uint32`	Encoded by this model
`records`	`[]TemplateRecord`	Encoded by this model

Template

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`account_id`	`string`	Optional when empty
`revision`	`int64`	Encoded by this model
`system`	`bool`	Encoded by this model
`specification`	`TemplateSpec`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

Zone

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`zone_name`	`string`	Encoded by this model
`mode`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`desired_state`	`string`	Encoded by this model
`observed_state`	`string`	Encoded by this model
`runtime_revision`	`int64`	Encoded by this model
`serial`	`uint32`	Encoded by this model
`configuration`	`lifecycle.Configuration`	Encoded by this model
`dnssec_status`	`string`	Encoded by this model
`key_tags`	`[]uint16`	Encoded by this model
`ds_records`	`[]lifecycle.DSRecord`	Encoded by this model
`last_verification`	`json.RawMessage`	Encoded by this model
`last_verified_at`	`*time.Time`	Optional when empty
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

Submission

JSON field	Type	Presence
`zone`	`Zone`	Encoded by this model
`operation`	`operations.Operation`	Encoded by this model
`replayed`	`bool`	Encoded by this model

Verify the actual endpoint

Read a harmless authorized resource and validate the returned API/model version before automation. For a write, use current revision or ETag, the endpoint-specific secret/preview contract and a stable reviewed idempotency key. Follow the durable task to its final state and inspect service evidence. Missing/unqualified native behavior remains a release limitation; a field name does not prove a live service or complete recovery.

← All EmailaPanel guides Get help →

Need help with EmailaPanel?

Tell us the product version and what you are trying to do. Keep passwords and private keys out of your message.

Contact Emaila