API & development

Database, user, query and binding 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.

Database

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`engine`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`account_blocked`	`bool`	Encoded by this model
`quota_bytes`	`*int64`	Optional when empty
`quota_enforced`	`bool`	Encoded by this model
`storage_bytes`	`*int64`	Optional when empty
`connection_count`	`*int`	Optional when empty
`observed_at`	`*time.Time`	Optional when empty
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model
`server_name`	`string`	Encoded by this model

User

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`database_id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`server_name`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`grants`	`[]lifecycle.Grant`	Encoded by this model
`revision`	`int64`	Encoded by this model
`credential_revision`	`int64`	Encoded by this model
`limits`	`lifecycle.UserLimits`	Encoded by this model
`limits_enforced`	`bool`	Encoded by this model
`account_blocked`	`bool`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

Binding

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`database_id`	`string`	Encoded by this model
`user_id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`website_id`	`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

Transfer

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`database_id`	`string`	Encoded by this model
`user_id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`action`	`string`	Encoded by this model
`source_path`	`string`	Optional when empty
`destination_path`	`string`	Optional when empty
`maximum_bytes`	`int64`	Encoded by this model
`timeout_seconds`	`int`	Encoded by this model
`status`	`string`	Encoded by this model
`bytes_processed`	`int64`	Encoded by this model
`result_digest`	`string`	Optional when empty
`failure_code`	`string`	Optional when empty
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

CreateRequest

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`engine`	`string`	Encoded by this model
`quota_bytes`	`*int64`	Optional when empty

ChangeRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`preview_token`	`string`	Optional when empty
`confirmation`	`string`	Optional when empty

DeletionPreview

JSON field	Type	Presence
`database_id`	`string`	Encoded by this model
`database_revision`	`int64`	Encoded by this model
`impact_digest`	`string`	Encoded by this model
`impacts`	`map[string]int64`	Encoded by this model
`preview_token`	`string`	Encoded by this model
`confirmation_phrase`	`string`	Encoded by this model
`expires_at`	`time.Time`	Encoded by this model

CreateUserRequest

JSON field	Type	Presence
`name`	`string`	Encoded by this model
`password`	`string`	Encoded by this model
`grants`	`[]lifecycle.Grant`	Encoded by this model
`limits`	`lifecycle.UserLimits`	Encoded by this model

UserChangeRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`password`	`string`	Optional when empty
`grants`	`[]lifecycle.Grant`	Optional when empty
`limits`	`*lifecycle.UserLimits`	Optional when empty

CreateBindingRequest

JSON field	Type	Presence
`user_id`	`string`	Encoded by this model
`website_id`	`string`	Encoded by this model
`password`	`string`	Encoded by this model

TransferRequest

JSON field	Type	Presence
`user_id`	`string`	Encoded by this model
`password`	`string`	Encoded by this model
`source_path`	`string`	Optional when empty
`destination_path`	`string`	Optional when empty
`maximum_bytes`	`int64`	Encoded by this model
`timeout_seconds`	`int`	Encoded by this model

QueryRequest

JSON field	Type	Presence
`user_id`	`string`	Encoded by this model
`password`	`string`	Encoded by this model
`statement`	`string`	Encoded by this model
`parameters`	`[]lifecycle.QueryValue`	Encoded by this model
`maximum_rows`	`int`	Encoded by this model
`maximum_bytes`	`int`	Encoded by this model
`timeout_seconds`	`int`	Encoded by this model

RemoteRequest

JSON field	Type	Presence
`engine`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`configuration`	`lifecycle.RemoteConfiguration`	Encoded by this model

RemotePreview

JSON field	Type	Presence
`engine`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`current`	`lifecycle.RemoteConfiguration`	Encoded by this model
`desired`	`lifecycle.RemoteConfiguration`	Encoded by this model
`impacts`	`[]string`	Encoded by this model
`preview_token`	`string`	Encoded by this model
`confirmation_phrase`	`string`	Encoded by this model
`expires_at`	`time.Time`	Encoded by this model

RemoteConfirmation

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

Submission

JSON field	Type	Presence
`database`	`*Database`	Optional when empty
`user`	`*User`	Optional when empty
`binding`	`*Binding`	Optional when empty
`transfer`	`*Transfer`	Optional when empty
`operation`	`operations.Operation`	Encoded by this model
`replayed`	`bool`	Encoded by this model

accountHookPlan

JSON field	Type	Presence
`databases`	`[]lifecycle.Plan`	Encoded by this model

accountHookReceipt

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`generation`	`int64`	Encoded by this model
`action`	`string`	Encoded by this model
`phase`	`string`	Encoded by this model
`databases`	`[]accountHookDatabase`	Encoded by this model

accountHookDatabase

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`plan`	`lifecycle.Plan`	Encoded by this model
`receipt`	`json.RawMessage`	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