API & development

Operation, phase, event and audit 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.

Input

JSON field	Type	Presence
`migration_plan_id`	`string`	Optional when empty
`control_plan_id`	`string`	Optional when empty
`value`	`string`	Optional when empty
`account_id`	`string`	Optional when empty
`website_id`	`string`	Optional when empty
`zone_id`	`string`	Optional when empty
`certificate_id`	`string`	Optional when empty
`database_id`	`string`	Optional when empty
`database_user_id`	`string`	Optional when empty
`database_binding_id`	`string`	Optional when empty
`mail_domain_id`	`string`	Optional when empty
`mailbox_id`	`string`	Optional when empty
`application_id`	`string`	Optional when empty
`schedule_id`	`string`	Optional when empty
`backup_id`	`string`	Optional when empty
`restore_plan_id`	`string`	Optional when empty
`destination_id`	`string`	Optional when empty
`engine`	`string`	Optional when empty
`package_id`	`string`	Optional when empty
`revision`	`int64`	Optional when empty
`revocation_reason`	`uint8`	Optional when empty

Request

JSON field	Type	Presence
`api_version`	`int`	Encoded by this model
`kind`	`string`	Encoded by this model
`resource_key`	`string`	Encoded by this model
`input`	`Input`	Encoded by this model
`timeout_ms`	`int`	Encoded by this model

Operation

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`sequence`	`int64`	Encoded by this model
`api_version`	`int`	Encoded by this model
`adapter_version`	`int`	Encoded by this model
`kind`	`string`	Encoded by this model
`resource_key`	`string`	Encoded by this model
`correlation_id`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`phase`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`deadline_at`	`time.Time`	Encoded by this model
`cancel_requested`	`bool`	Encoded by this model
`delivery_count`	`int`	Encoded by this model
`retry_count`	`int`	Encoded by this model
`failure_code`	`string`	Encoded by this model
`finished_at`	`*time.Time`	Encoded by this model

Event

JSON field	Type	Presence
`sequence`	`int64`	Encoded by this model
`operation_id`	`string`	Encoded by this model
`kind`	`string`	Encoded by this model
`phase`	`string`	Encoded by this model
`code`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model

Audit

JSON field	Type	Presence
`sequence`	`int64`	Encoded by this model
`actor_scope`	`string`	Encoded by this model
`action`	`string`	Encoded by this model
`operation_id`	`*string`	Encoded by this model
`resource_key`	`*string`	Encoded by this model
`correlation_id`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model

Account

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`principal_id`	`*int64`	Encoded by this model
`name`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model

Website

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model

Resource

JSON field	Type	Presence
`resource_key`	`string`	Encoded by this model
`kind`	`string`	Encoded by this model
`account_id`	`*string`	Encoded by this model
`website_id`	`*string`	Encoded by this model
`zone_id`	`*string`	Encoded by this model
`certificate_id`	`*string`	Encoded by this model
`database_id`	`*string`	Encoded by this model
`mail_domain_id`	`*string`	Encoded by this model
`state`	`string`	Encoded by this model
`created_at`	`time.Time`	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