API & development

Databases, users, bindings and remote access API

All 24 versioned routes in this family with authorization and request boundaries.

Platform
Go
Technology
Go

Read this contract with the installed version

Use API authentication and request conventions first. Paths below are normalized; mount under the correct local Admin or Customer namespace. Every handler independently enforces current authorization, resource/account scope, feature/licence state and actual installed capability. A listed route is not a token-scope grant or native production acceptance. Read the operational procedure and fields before changing data. The newer source reference includes preparation/activation routes which earlier kits may not expose.

Every route in this family

Method Normalized path Request and effect
GET /v1/database-capabilities Read authorized state/content; inspect observation time and pagination.
GET /v1/databases Read authorized state/content; inspect observation time and pagination.
POST /v1/databases Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
GET /v1/databases/{id} Read authorized state/content; inspect observation time and pagination.
POST /v1/databases/{id}/deletion-preview Create/read the exact server-generated impact and confirmation; preview is not apply.
POST /v1/databases/{id}/suspend Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/reactivate Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/delete Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
GET /v1/databases/{id}/users Read authorized state/content; inspect observation time and pagination.
POST /v1/databases/{id}/users Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/users/{user_id}/grants Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/users/{user_id}/limits Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/users/{user_id}/rotate Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/users/{user_id}/delete Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
GET /v1/databases/{id}/bindings Read authorized state/content; inspect observation time and pagination.
POST /v1/databases/{id}/bindings Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
DELETE /v1/databases/{id}/bindings/{binding_id} Explicit current-resource removal/revocation; inspect retained history/ownership first.
POST /v1/databases/{id}/import Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/export Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/backup Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
POST /v1/databases/{id}/query Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.
GET /v1/database-remote/{engine} Read authorized state/content; inspect observation time and pagination.
POST /v1/database-remote/{engine}/preview Create/read the exact server-generated impact and confirmation; preview is not apply.
POST /v1/database-remote/{engine}/configure Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable.

Delivery, verification and errors

A returned operation or 202 means accepted work, not completed service change. Retain the operation ID and inspect events and actual resource state. Preserve one idempotency key for a reviewed ambiguous-delivery attempt. Current revision/ETag, exact impact preview and confirmation are separate protection mechanisms; do not guess or reuse stale values.

For 401, restore a valid local session/token. For 403, inspect the actual typed authorization/freshness/licence denial; generic denial is not automatically a password prompt. For 409, reload changed state or inspect the original operation. A capability/storage/agent 503 stays unavailable. Never place passwords, bearer tokens, private keys or recovery material in a URL. The complete request/response field reference distinguishes internal lifecycle models from public client input.

← 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