API & development

Account and package 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.

PackageSpec

JSON field	Type	Presence
`name`	`string`	Encoded by this model
`bandwidth_allowance_bytes`	`int64`	Optional when empty
`transfer_limit`	`*int`	Optional when empty
`features`	`*[]string`	Optional when empty
`website_limit`	`int`	Encoded by this model
`mailbox_limit`	`int`	Encoded by this model
`database_limit`	`int`	Encoded by this model
`storage_bytes`	`int64`	Encoded by this model
`storage_inodes`	`int64`	Encoded by this model
`cpu_quota_percent`	`int`	Encoded by this model
`memory_max_bytes`	`int64`	Encoded by this model
`memory_swap_max_bytes`	`int64`	Encoded by this model
`tasks_max`	`int`	Encoded by this model
`io_read_bytes_per_sec`	`int64`	Encoded by this model
`io_write_bytes_per_sec`	`int64`	Encoded by this model
`limit_mode`	`string`	Encoded by this model
`guarantee_cpu`	`bool`	Encoded by this model
`guarantee_memory`	`bool`	Encoded by this model
`guarantee_io`	`bool`	Encoded by this model

Package

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`bandwidth_allowance_bytes`	`int64`	Encoded by this model
`bandwidth_enforcement`	`string`	Encoded by this model
`transfer_limit`	`int`	Encoded by this model
`features`	`[]string`	Encoded by this model
`base_package_id`	`string`	Optional when empty
`overrides`	`*PackageOverrides`	Optional when empty
`name`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`status`	`string`	Encoded by this model
`limits`	`lifecycle.Limits`	Encoded by this model
`limit_mode`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model

CreateRequest

JSON field	Type	Presence
`name`	`string`	Encoded by this model
`primary_domain`	`string`	Optional when empty
`login`	`string`	Encoded by this model
`password`	`string`	Encoded by this model
`package_id`	`string`	Encoded by this model
`contact_email`	`string`	Optional when empty
`overrides`	`*PackageOverrides`	Optional when empty

ChangeRequest

JSON field	Type	Presence
`package_id`	`string`	Optional when empty
`revision`	`int64`	Encoded by this model
`overrides`	`*PackageOverrides`	Optional when empty
`preserve_overrides`	`bool`	Optional when empty

ConfirmTermination

JSON field	Type	Presence
`preview_token`	`string`	Encoded by this model
`confirmation_phrase`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model

Runtime

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`package_id`	`string`	Encoded by this model
`os_name`	`string`	Optional when empty
`uid`	`*int64`	Optional when empty
`gid`	`*int64`	Optional when empty
`desired_state`	`string`	Encoded by this model
`observed_state`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`limits_enforced`	`bool`	Encoded by this model

Account

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`primary_domain`	`string`	Encoded by this model
`primary_domain_state`	`string`	Optional when empty
`contact_email`	`string`	Encoded by this model
`usage_summary`	`UsageSummary`	Encoded by this model
`warnings`	`[]UsageWarning`	Encoded by this model
`principal_id`	`int64`	Encoded by this model
`name`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model
`login`	`string`	Encoded by this model
`managed`	`bool`	Encoded by this model
`base_package`	`*Package`	Optional when empty
`package`	`*Package`	Optional when empty
`enforcement`	`json.RawMessage`	Optional when empty
`usage`	`json.RawMessage`	Optional when empty
`usage_observed_at`	`*time.Time`	Optional when empty
`runtime`	`*Runtime`	Optional when empty

Preview

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`account_revision`	`int64`	Encoded by this model
`expires_at`	`time.Time`	Encoded by this model
`preview_token`	`string`	Encoded by this model
`confirmation_phrase`	`string`	Encoded by this model
`impacts`	`[]lifecycle.Impact`	Encoded by this model

Submission

JSON field	Type	Presence
`account`	`Account`	Encoded by this model
`operation`	`operations.Operation`	Encoded by this model
`replayed`	`bool`	Encoded by this model

Limits

JSON field	Type	Presence
`website_count`	`int`	Encoded by this model
`mailbox_count`	`int`	Encoded by this model
`database_count`	`int`	Encoded by this model
`storage_bytes`	`int64`	Encoded by this model
`storage_inodes`	`int64`	Encoded by this model
`cpu_quota_percent`	`int`	Encoded by this model
`memory_max_bytes`	`int64`	Encoded by this model
`memory_swap_max_bytes`	`int64`	Encoded by this model
`tasks_max`	`int`	Encoded by this model
`io_read_bytes_per_sec`	`int64`	Encoded by this model
`io_write_bytes_per_sec`	`int64`	Encoded by this model

Capabilities

JSON field	Type	Presence
`available`	`bool`	Encoded by this model
`identity`	`bool`	Encoded by this model
`filesystem`	`bool`	Encoded by this model
`storage_quota`	`bool`	Encoded by this model
`cpu`	`bool`	Encoded by this model
`memory`	`bool`	Encoded by this model
`processes`	`bool`	Encoded by this model
`io`	`bool`	Encoded by this model
`allocatable_storage_bytes`	`int64`	Encoded by this model
`configured_storage_budget_bytes`	`int64`	Encoded by this model
`storage_host_reserve_bytes`	`int64`	Encoded by this model
`storage_host_reserve_available`	`bool`	Encoded by this model
`observed_at`	`time.Time`	Encoded by this model
`evidence`	`json.RawMessage`	Optional when empty

Plan

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`package_id`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`action`	`string`	Encoded by this model
`previous_state`	`string`	Encoded by this model
`desired_state`	`string`	Encoded by this model
`limits`	`Limits`	Encoded by this model
`previous_limits`	`Limits`	Encoded by this model

HookPlan

JSON field	Type	Presence
`name`	`string`	Encoded by this model
`version`	`int`	Encoded by this model
`input`	`json.RawMessage`	Encoded by this model

Observation

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`operation_id`	`string`	Optional when empty
`generation`	`int64`	Optional when empty
`action`	`string`	Optional when empty
`limits`	`Limits`	Encoded by this model
`phase`	`string`	Optional when empty
`state`	`string`	Encoded by this model
`os_name`	`string`	Optional when empty
`uid`	`int64`	Optional when empty
`gid`	`int64`	Optional when empty
`limits_enforced`	`bool`	Encoded by this model
`enforcement`	`json.RawMessage`	Encoded by this model
`usage`	`json.RawMessage`	Encoded by this model
`receipt`	`json.RawMessage`	Encoded by this model

Impact

JSON field	Type	Presence
`hook`	`string`	Encoded by this model
`kind`	`string`	Encoded by this model
`count`	`int64`	Encoded by this model
`detail`	`string`	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