API & development

File, upload and transfer 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.

Upload

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`destination_path`	`string`	Encoded by this model
`expected_bytes`	`int64`	Encoded by this model
`acknowledged_bytes`	`int64`	Encoded by this model
`etag`	`string`	Optional when empty
`content_sha256`	`string`	Optional when empty
`status`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`expires_at`	`time.Time`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

UploadEvent

JSON field	Type	Presence
`sequence`	`int64`	Encoded by this model
`kind`	`string`	Encoded by this model
`acknowledged_bytes`	`int64`	Encoded by this model
`detail_code`	`string`	Optional when empty
`created_at`	`time.Time`	Encoded by this model

TrashItem

JSON field	Type	Presence
`trash_id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`original_path`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`etag`	`string`	Encoded by this model
`trashed_at`	`time.Time`	Encoded by this model
`restored_path`	`string`	Optional when empty
`updated_at`	`time.Time`	Encoded by this model

CreateUpload

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`destination_path`	`string`	Encoded by this model
`expected_bytes`	`int64`	Encoded by this model

ActionRequest

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`action`	`string`	Encoded by this model
`paths`	`[]string`	Encoded by this model
`expected_etags`	`map[string]string`	Optional when empty
`destination_path`	`string`	Optional when empty
`mode`	`uint32`	Optional when empty
`archive_format`	`fileops.ArchiveFormat`	Optional when empty
`recursive`	`bool`	Optional when empty

ActionResult

JSON field	Type	Presence
`trash`	`*fileops.TrashReceipt`	Optional when empty
`archive`	`*fileops.ArchiveResult`	Optional when empty
`extract`	`*fileops.ExtractResult`	Optional when empty

TextUpdate

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`path`	`string`	Encoded by this model
`expected_version`	`string`	Encoded by this model
`content`	`string`	Encoded by this model

CreateRequest

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`display_name`	`string`	Encoded by this model
`access_mode`	`string`	Encoded by this model
`sftp_enabled`	`bool`	Encoded by this model
`ftps_enabled`	`bool`	Encoded by this model

RevisionRequest

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

AddKeyRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`label`	`string`	Encoded by this model
`public_key`	`string`	Encoded by this model

PublicKey

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`label`	`string`	Encoded by this model
`algorithm`	`string`	Encoded by this model
`public_key`	`string`	Encoded by this model
`fingerprint_sha256`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`revoked_at`	`*time.Time`	Optional when empty

User

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`login_name`	`string`	Encoded by this model
`display_name`	`string`	Encoded by this model
`root_path`	`string`	Encoded by this model
`access_mode`	`string`	Encoded by this model
`sftp_enabled`	`bool`	Encoded by this model
`ftps_enabled`	`bool`	Encoded by this model
`desired_state`	`string`	Encoded by this model
`observed_state`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`keys`	`[]PublicKey`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

PublicKey

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`label`	`string`	Encoded by this model
`algorithm`	`string`	Encoded by this model
`key`	`string`	Encoded by this model
`fingerprint`	`string`	Encoded by this model

Identity

JSON field	Type	Presence
`version`	`int`	Encoded by this model
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`account_uid`	`uint32`	Encoded by this model
`account_gid`	`uint32`	Encoded by this model
`account_state`	`string`	Encoded by this model
`uid`	`uint32`	Encoded by this model
`scope`	`string`	Encoded by this model
`state`	`string`	Encoded by this model
`sftp_enabled`	`bool`	Encoded by this model
`ftps_enabled`	`bool`	Encoded by this model
`ftps_credential_revision`	`uint64`	Optional when empty
`keys`	`[]PublicKey`	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