API & development

Website and PHP 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
`primary_domain`	`string`	Encoded by this model
`aliases`	`[]string`	Encoded by this model
`subdomains`	`[]string`	Encoded by this model
`mode`	`string`	Encoded by this model
`apache_compatibility`	`bool`	Encoded by this model
`php_version`	`string`	Optional when empty
`document_root`	`string`	Encoded by this model
`php_ini`	`map[string]string`	Encoded by this model
`redirects`	`[]lifecycle.Redirect`	Encoded by this model
`custom_errors`	`[]lifecycle.CustomError`	Encoded by this model
`mime_types`	`[]lifecycle.MIMETypeOverride`	Optional when empty

ModifyRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`primary_domain`	`string`	Encoded by this model
`aliases`	`[]string`	Encoded by this model
`subdomains`	`[]string`	Encoded by this model
`mode`	`string`	Encoded by this model
`apache_compatibility`	`bool`	Encoded by this model
`php_version`	`string`	Optional when empty
`document_root`	`string`	Encoded by this model
`php_ini`	`map[string]string`	Encoded by this model
`redirects`	`[]lifecycle.Redirect`	Encoded by this model
`custom_errors`	`[]lifecycle.CustomError`	Encoded by this model
`mime_types`	`[]lifecycle.MIMETypeOverride`	Optional when empty

ChangeRequest

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

Website

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`primary_domain`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`account_blocked`	`bool`	Encoded by this model
`managed`	`bool`	Encoded by this model
`desired_state`	`string`	Optional when empty
`observed_state`	`string`	Optional when empty
`runtime_revision`	`int64`	Optional when empty
`configuration`	`*lifecycle.Configuration`	Optional when empty
`access_log`	`string`	Optional when empty
`error_log`	`string`	Optional when empty
`health_status`	`string`	Optional when empty
`dns_status`	`string`	Encoded by this model
`ssl_status`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

Submission

JSON field	Type	Presence
`website`	`Website`	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