API & development

Server, security and website-protection 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.

Preview

JSON field Type Presence
preview_id string Encoded by this model
expires_at time.Time Encoded by this model
confirmation string Encoded by this model
preview json.RawMessage Encoded by this model

Submission

JSON field Type Presence
operation_id string Encoded by this model
replayed bool Encoded by this model

SubmitRequest

JSON field Type Presence
api_version int Encoded by this model
preview_id string Encoded by this model
confirmation string Encoded by this model

Alert

JSON field Type Presence
id string Encoded by this model
key string Encoded by this model
kind string Encoded by this model
resource_key string Encoded by this model
account_id string Optional when empty
state string Encoded by this model
severity string Encoded by this model
code string Encoded by this model
occurrences int64 Encoded by this model
first_seen_at time.Time Encoded by this model
last_seen_at time.Time Encoded by this model
recovered_at *time.Time Encoded by this model
notification_status string Encoded by this model
observation_started_at *time.Time Optional when empty
observation_completed_at *time.Time Optional when empty

AccountSecurity

JSON field Type Presence
account_id string Encoded by this model
locked bool Encoded by this model
session_epoch int64 Encoded by this model
token_count int Encoded by this model
access map[string]bool Encoded by this model
usage any Encoded by this model
controls map[string]bool Encoded by this model

CPU

JSON field Type Presence
logical int Encoded by this model
total_ticks uint64 Encoded by this model
idle_ticks uint64 Encoded by this model
busy_percent *float64 Optional when empty
sample_seconds float64 Encoded by this model
status string Encoded by this model

Memory

JSON field Type Presence
total_bytes uint64 Encoded by this model
available_bytes uint64 Encoded by this model
swap_total_bytes uint64 Encoded by this model
swap_free_bytes uint64 Encoded by this model

LoadAverage

JSON field Type Presence
one_minute float64 Encoded by this model
five_minutes float64 Encoded by this model
fifteen_minutes float64 Encoded by this model
running_tasks uint64 Encoded by this model
total_tasks uint64 Encoded by this model
status string Encoded by this model
coverage string Encoded by this model

Filesystem

JSON field Type Presence
mount string Encoded by this model
type string Encoded by this model
total_bytes uint64 Encoded by this model
available_bytes uint64 Encoded by this model
inodes uint64 Encoded by this model
free_inodes uint64 Encoded by this model
status string Encoded by this model

InterfaceTraffic

JSON field Type Presence
interface string Encoded by this model
receive_bytes uint64 Encoded by this model
transmit_bytes uint64 Encoded by this model
receive_drops uint64 Encoded by this model
transmit_drops uint64 Encoded by this model

Traffic

JSON field Type Presence
status string Encoded by this model
coverage string Encoded by this model
per_account_accounting bool Encoded by this model
interfaces []InterfaceTraffic Encoded by this model

Service

JSON field Type Presence
id string Encoded by this model
state string Encoded by this model
sub_state string Encoded by this model
enabled string Encoded by this model
load_state string Encoded by this model
actions []string Encoded by this model
dependents []string Encoded by this model
dependencies []string Optional when empty
status string Encoded by this model
invocation_id string Optional when empty
execution_fingerprint string Optional when empty
stop_fingerprint string Optional when empty
reload_fingerprint string Optional when empty
reload_result string Optional when empty
website *WebsiteTarget Optional when empty
dependency_fingerprint string Optional when empty
runtime_policy *PHPRuntimePolicy Optional when empty
dns *DNSServiceProof Optional when empty

PHPRuntimePolicy

JSON field Type Presence
version int Encoded by this model
revision uint64 Encoded by this model
desired_runtime string Encoded by this model
boot_enabled bool Encoded by this model
status string Encoded by this model
owner_operation_id string Encoded by this model

WebsiteTarget

JSON field Type Presence
website_id string Encoded by this model
account_id string Encoded by this model
uid uint32 Encoded by this model
account_revision uint64 Encoded by this model
website_revision int64 Encoded by this model
website_generation int64 Encoded by this model
website_operation_id string Encoded by this model
configuration_digest string Encoded by this model
policy_revision uint64 Optional when empty

Process

JSON field Type Presence
pid int Encoded by this model
uid uint32 Encoded by this model
account_id string Optional when empty
name string Encoded by this model
state string Encoded by this model
resident_bytes uint64 Encoded by this model
cpu_ticks uint64 Encoded by this model
start_ticks uint64 Encoded by this model
control *ProcessTarget Optional when empty
actions []string Optional when empty

ProcessTarget

JSON field Type Presence
pid int Encoded by this model
uid uint32 Encoded by this model
account_id string Encoded by this model
account_revision uint64 Encoded by this model
start_ticks uint64 Encoded by this model
boot_id string Encoded by this model
cgroup string Encoded by this model

ProcessResult

JSON field Type Presence
pid int Encoded by this model
start_ticks uint64 Encoded by this model
outcome string Encoded by this model
signal string Encoded by this model
exited bool Encoded by this model

AccountUsage

JSON field Type Presence
account_id string Encoded by this model
state string Encoded by this model
uid uint32 Encoded by this model
usage_status string Encoded by this model
cgroup_status string Encoded by this model
cgroup_live bool Encoded by this model
quota_applied bool Encoded by this model
storage_bytes_used uint64 Encoded by this model
storage_inodes_used uint64 Encoded by this model
memory_current_bytes uint64 Encoded by this model
tasks_current uint64 Encoded by this model
cpu_usage_usec uint64 Encoded by this model
io_read_bytes uint64 Encoded by this model
io_write_bytes uint64 Encoded by this model

SecurityPackage

JSON field Type Presence
package string Encoded by this model
installed string Encoded by this model
candidate string Encoded by this model
security_update bool Encoded by this model

SecurityUpdates

JSON field Type Presence
status string Encoded by this model
observed_at time.Time Optional when empty
source string Encoded by this model
packages []SecurityPackage Encoded by this model
warning string Optional when empty

Validation

JSON field Type Presence
id string Encoded by this model
status string Encoded by this model
code string Optional when empty

Settings

JSON field Type Presence
hostname string Encoded by this model
persistent_hostname string Encoded by this model
resolver_addresses []string Encoded by this model
live_resolver_addresses []string Encoded by this model
bindings []string Encoded by this model
maintenance bool Encoded by this model
boot_id string Encoded by this model
status string Encoded by this model
maintenance_window *MaintenanceWindow Optional when empty
maintenance_window_owner string Optional when empty
manual_maintenance *bool Optional when empty
journal_rotation *JournalRotation Optional when empty
temporary_cleanup *TemporaryCleanup Optional when empty

TemporaryCleanup

JSON field Type Presence
status string Encoded by this model
scope string Encoded by this model
eligible_before time.Time Encoded by this model
eligible_files int Encoded by this model
eligible_bytes int64 Encoded by this model
retained_candidates int Encoded by this model
limited bool Encoded by this model
inventory_digest string Encoded by this model

JournalRotation

JSON field Type Presence
status string Encoded by this model
storage string Encoded by this model
directory_device uint64 Encoded by this model
directory_inode uint64 Encoded by this model
active_device uint64 Encoded by this model
active_inode uint64 Encoded by this model
archived_inodes []uint64 Encoded by this model

MaintenanceWindow

JSON field Type Presence
starts_at time.Time Encoded by this model
ends_at time.Time Encoded by this model

MaintenanceStatus

JSON field Type Presence
configured bool Encoded by this model
enabled bool Encoded by this model

Snapshot

JSON field Type Presence
version int Encoded by this model
observed_at time.Time Encoded by this model
boot_id string Encoded by this model
hostname string Encoded by this model
maintenance bool Encoded by this model
settings Settings Encoded by this model
cpu CPU Encoded by this model
load LoadAverage Encoded by this model
memory Memory Encoded by this model
filesystems []Filesystem Encoded by this model
traffic Traffic Encoded by this model
services []Service Encoded by this model
accounts []AccountUsage Encoded by this model
account_limit_reached bool Encoded by this model
processes []Process Encoded by this model
process_limit_reached bool Encoded by this model
security_updates SecurityUpdates Encoded by this model
validation []Validation Encoded by this model
capabilities map[string]bool Encoded by this model
warnings []string Encoded by this model

LogRequest

JSON field Type Presence
account_id string Optional when empty
website_id string Optional when empty
service_id string Optional when empty
kind string Optional when empty
limit int Encoded by this model

LogResult

JSON field Type Presence
account_id string Optional when empty
website_id string Optional when empty
service_id string Optional when empty
kind string Encoded by this model
content string Encoded by this model
bytes_read int Encoded by this model
truncated bool Encoded by this model
redaction string Encoded by this model

ChangeRequest

JSON field Type Presence
action string Encoded by this model
service_id string Optional when empty
hostname string Optional when empty
resolver_addresses []string Optional when empty
bindings []string Optional when empty
maintenance bool Optional when empty
maintenance_window *MaintenanceWindow Optional when empty
process *ProcessTarget Optional when empty
website *WebsiteTarget Optional when empty

ChangePreview

JSON field Type Presence
version int Encoded by this model
request ChangeRequest Encoded by this model
digest string Encoded by this model
actual_fingerprint string Encoded by this model
created_at time.Time Encoded by this model
expires_at time.Time Encoded by this model
impact []string Encoded by this model
resources []string Encoded by this model
before Service Encoded by this model
before_settings *Settings Optional when empty
before_process *Process Optional when empty
process_wait_seconds int Optional when empty
requires_reconnect bool Encoded by this model
reversible bool Encoded by this model
confirmation string Encoded by this model

ChangeResult

JSON field Type Presence
operation_id string Encoded by this model
generation int64 Encoded by this model
phase string Encoded by this model
replayed bool Encoded by this model
service Service Encoded by this model
settings *Settings Optional when empty
process *ProcessResult Optional when empty
code string Optional when empty
reconcile_required bool Encoded by this model

Change

JSON field Type Presence
action string Encoded by this model
website_id string Encoded by this model
finding_id string Optional when empty

Limits

JSON field Type Presence
files int Encoded by this model
file_bytes int64 Encoded by this model
total_bytes int64 Encoded by this model

Scanner

JSON field Type Presence
pid int32 Encoded by this model
uid uint32 Encoded by this model
gid uint32 Encoded by this model
engine_version string Encoded by this model
database_version uint64 Encoded by this model
definitions_built_at time.Time Encoded by this model

ScanRequest

JSON field Type Presence
version int Encoded by this model
request_id string Encoded by this model
website_id string Encoded by this model
document_root string Encoded by this model
limits Limits Encoded by this model
scanner Scanner Encoded by this model

FileStamp

JSON field Type Presence
device uint64 Encoded by this model
inode uint64 Encoded by this model
uid uint32 Encoded by this model
gid uint32 Encoded by this model
mode uint32 Encoded by this model
size int64 Encoded by this model
modified_ns int64 Encoded by this model
changed_ns int64 Encoded by this model

Finding

JSON field Type Presence
id string Encoded by this model
relative_path string Encoded by this model
stamp FileStamp Encoded by this model
sha256 string Encoded by this model
signature string Encoded by this model

ScanResult

JSON field Type Presence
version int Encoded by this model
request_id string Encoded by this model
website_id string Encoded by this model
outcome string Encoded by this model
code string Encoded by this model
started_at time.Time Encoded by this model
completed_at time.Time Encoded by this model
files int Encoded by this model
bytes int64 Encoded by this model
skipped int Encoded by this model
limit_reached bool Encoded by this model
findings []Finding Encoded by this model

Request

JSON field Type Presence
account_id string Encoded by this model
categories []string Optional when empty

Quota

JSON field Type Presence
storage_bytes_used uint64 Encoded by this model
storage_inodes_used uint64 Encoded by this model
uid_quota_enforced bool Encoded by this model
cgroup_status string Encoded by this model

Check

JSON field Type Presence
resource_id string Encoded by this model
status string Encoded by this model
code string Encoded by this model
scope string Encoded by this model
observed_at time.Time Encoded by this model
quota *Quota Optional when empty

Category

JSON field Type Presence
id string Encoded by this model
status string Encoded by this model
limited bool Encoded by this model
checks []Check Encoded by this model

Report

JSON field Type Presence
version int Encoded by this model
account_id string Encoded by this model
account_revision uint64 Encoded by this model
source string Encoded by this model
observed_at time.Time Encoded by this model
categories []Category 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 guidesGet 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