Hướng dẫn sử dụng ZoCloud English Vào ZoCloud

Tham chiếu API

API reference. Mọi route của API ZoCloud tại https://api.zocloud.io/v1, theo nhóm, sinh tự động từ bảng route của máy chủ: trang này luôn khớp với bản đang chạy. Tài liệu máy đọc được (OpenAPI 3.1): /v1/openapi.json, cũng tại https://api.zocloud.io/v1/openapi.json.

Every route of the ZoCloud API at https://api.zocloud.io/v1, grouped, generated from the server's route table, so it always matches the running release. Machine-readable (OpenAPI 3.1): /v1/openapi.json, also at https://api.zocloud.io/v1/openapi.json.

Cách gọi · How to call

  • Đăng nhập · Sign in: Authorization: Bearer zc_pat_… với token tạo ở Tài khoản → Token truy cập (xem zo CLI và MCP server: token có thể giới hạn trong một tổ chức và chỉ đọc). Portal dùng cookie phiên kèm header X-CSRF-Token. Route nhân viên (/v1/admin/…) chỉ nhận phiên của nhân viên ZoCloud, không nhận token. Route có cột đăng nhập — là công khai.
  • Dữ liệu · Bodies: JSON (Content-Type: application/json) cả hai chiều; 204 khi không có gì trả về. Tài liệu này không mô tả từng trường: mỗi route ghi tóm tắt trường nó nhận và trả; ví dụ đầy đủ ở các trang hướng dẫn. Route …/deployments/upload nhận file .tar.gz.
  • Lỗi · Errors: {"error": {"code", "params", "message", "steps"}}. code dạng nhóm.lỗi (ví dụ api.token_read_only), dịch được bằng locales/<lang>/errors.json; steps là việc cần làm tiếp và trang portal tương ứng. Mã HTTP: 401 chưa đăng nhập, 403 không được phép, 404 không có, 409 đã tồn tại, 429 quá nhiều yêu cầu (có Retry-After).
  • Môi trường · Environments: route của service, database và bucket cũng có dạng …/projects/{project}/envs/{env}/… cho môi trường khác production (preview của pull request).
  • Giới hạn · Rate limits: theo token hoặc người dùng mỗi phút, theo địa chỉ với route công khai.

Các nhóm · Groups

activity

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/activity token The organisation's activity log (what members, staff and the platform did), newest first; ?area= and ?before= filter

advisor

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/suggestions token The Advisor's open suggestions for the organisation, in the reader's language
POST /v1/orgs/{org}/suggestions/{id}/dismiss token Hide a suggestion for good
POST /v1/orgs/{org}/suggestions/{id}/snooze token Hide a suggestion for a while (it comes back if still true)

ai-gateway

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/ai/chat/completions — OpenAI-compatible chat completions, by AI key (Authorization: Bearer zcai_…); streams when asked
POST /v1/ai/embeddings — OpenAI-compatible embeddings, by AI key
GET /v1/ai/models — The models on offer, in OpenAI's list format, by AI key
GET /v1/ai/pricing — The models' prices per million tokens, VAT included

ai-keys

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/ai/keys token List the organisation's AI keys (prefix, limit, this month's spend)
POST /v1/orgs/{org}/ai/keys token Create an AI key (name, monthly_limit_vnd); the secret is returned once
PATCH /v1/orgs/{org}/ai/keys/{id} token Change an AI key's name, monthly limit (null removes it) or turn it off and on
DELETE /v1/orgs/{org}/ai/keys/{id} token Revoke an AI key
GET /v1/orgs/{org}/ai/usage token AI usage per day and model (?days=)

auth

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/auth/forgot — Send a password reset link to the address, if it has an account
GET /v1/auth/google/callback — Where Google sends the person back; opens the session
GET /v1/auth/google/start — Begin signing in with Google (redirects to Google)
POST /v1/auth/login — Sign in with email and password; sets the session cookie and says whether a two-factor code is needed
POST /v1/auth/logout — Sign the session out and clear its cookies
POST /v1/auth/mfa — Finish signing in with the two-factor code (or a recovery code)
GET /v1/auth/providers — Which sign-in providers are on (Google)
POST /v1/auth/reset — Set a new password with the token from the reset link
POST /v1/auth/signup — Create an account and its personal organisation (email, password, name, locale, terms accepted); signs in
POST /v1/auth/verify — Verify an e-mail address with the token from the verification link

billing

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/billing-details token The invoicing details (company name, tax code, address)
PUT /v1/orgs/{org}/billing-details token Set the invoicing details
GET /v1/orgs/{org}/invoices token List the monthly statements and e-invoices
GET /v1/orgs/{org}/invoices/{id} token One statement with its lines (printable)
GET /v1/orgs/{org}/payments token List the organisation's payments
POST /v1/orgs/{org}/payments token Start a top-up (amount, gateway); returns where to pay
GET /v1/orgs/{org}/payments/methods token The payment methods on offer and the top-up limits
GET /v1/orgs/{org}/payments/{id} token One payment and its state
GET /v1/orgs/{org}/wallet token The wallet's balance
GET /v1/orgs/{org}/wallet/transactions token The wallet's transactions, newest first

buckets

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/buckets token List the project's S3 buckets with their usage
POST /v1/orgs/{org}/projects/{project}/buckets token Create a bucket (slug, quota in MB)
GET /v1/orgs/{org}/projects/{project}/buckets/{bucket} token A bucket: name, endpoint, region, quota, usage
PATCH /v1/orgs/{org}/projects/{project}/buckets/{bucket} token Change a bucket's quota
DELETE /v1/orgs/{org}/projects/{project}/buckets/{bucket} token Delete a bucket and its objects (?confirm=slug)
GET /v1/orgs/{org}/projects/{project}/buckets/{bucket}/variables token The S3 credentials and endpoint as variables (S3_ENDPOINT, S3_BUCKET, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY)
GET /v1/orgs/{org}/projects/{project}/envs/{env}/buckets token List the project's S3 buckets with their usage (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/buckets token Create a bucket (slug, quota in MB) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket} token A bucket: name, endpoint, region, quota, usage (in the environment {env})
PATCH /v1/orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket} token Change a bucket's quota (in the environment {env})
DELETE /v1/orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket} token Delete a bucket and its objects (?confirm=slug) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket}/variables token The S3 credentials and endpoint as variables (S3_ENDPOINT, S3_BUCKET, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY) (in the environment {env})

chat

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/chat-status token Whether Ask ZoCloud is available
GET /v1/orgs/{org}/chats token Ask ZoCloud: the member's latest conversations in the organisation
POST /v1/orgs/{org}/chats token Ask ZoCloud a question ({chat_id?, message, context?}); the answer follows in the background (poll the chat)
GET /v1/orgs/{org}/chats/{id} token A conversation: its messages, what ZoCloud is doing, the questions left today
POST /v1/orgs/{org}/chats/{id}/messages/{mid}/answer token Agree to (or decline) a change ZoCloud proposed ({accept}); agreed, it is made and ZoCloud follows up
POST /v1/orgs/{org}/chats/{id}/ticket token Hand the conversation to the support team as a ticket
GET /v1/site/chat — Whether the website's Ask ZoCloud is available
POST /v1/site/chat — The website's Ask ZoCloud: a visitor's question (a new chat returns its secret token; later calls send it as X-Chat-Token)
GET /v1/site/chat/{id} — A visitor's conversation (X-Chat-Token)

cloudflare

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/cloudflare token The Cloudflare accounts connected to the organisation
POST /v1/orgs/{org}/cloudflare token Connect a Cloudflare account with an API token (kept encrypted)
PATCH /v1/orgs/{org}/cloudflare-zones/{zone} token Change a managed zone's protection level, caching and login rate limit
DELETE /v1/orgs/{org}/cloudflare-zones/{zone} token Stop managing a zone (its rules are removed)
DELETE /v1/orgs/{org}/cloudflare/{id} token Disconnect a Cloudflare account
GET /v1/orgs/{org}/cloudflare/{id}/zones token The zones the Cloudflare account can manage
POST /v1/orgs/{org}/cloudflare/{id}/zones token Put a zone under ZoCloud's management (DNS, edge rules, origin pulls)

cron

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/runs token A cron service's recent runs (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/runs token Run a cron service now (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/runs token A cron service's recent runs
POST /v1/orgs/{org}/projects/{project}/services/{service}/runs token Run a cron service now

custom-domains

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/domains token List the service's custom domains with their DNS and certificate state (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/domains token Add a custom domain (hostname); returns what to point DNS at (in the environment {env})
DELETE /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/domains/{hostname} token Remove a custom domain (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/domains token List the service's custom domains with their DNS and certificate state
POST /v1/orgs/{org}/projects/{project}/services/{service}/domains token Add a custom domain (hostname); returns what to point DNS at
DELETE /v1/orgs/{org}/projects/{project}/services/{service}/domains/{hostname} token Remove a custom domain

database-backups

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/databases/{db}/backups token List the database's backups
POST /v1/orgs/{org}/projects/{project}/databases/{db}/backups token Back the database up now
GET /v1/orgs/{org}/projects/{project}/databases/{db}/backups/{id}/download token Download a backup's dump, decrypted (pg_dump custom, .sql or .rdb); databases.backups.downloads_per_hour per organisation
POST /v1/orgs/{org}/projects/{project}/databases/{db}/restore token Restore the database from a backup (backup id) or to a point in time
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/backups token List the database's backups (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/backups token Back the database up now (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/backups/{id}/download token Download a backup's dump, decrypted (pg_dump custom, .sql or .rdb); databases.backups.downloads_per_hour per organisation (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/restore token Restore the database from a backup (backup id) or to a point in time (in the environment {env})

database-data

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/orgs/{org}/projects/{project}/databases/{db}/query token Run a query (sql) with a row limit; recorded in the activity log
GET /v1/orgs/{org}/projects/{project}/databases/{db}/rows token A page of a table's rows (?table=, ?offset=, ?limit=)
GET /v1/orgs/{org}/projects/{project}/databases/{db}/tables token The tables (or keys) with row counts, for the data console
POST /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/query token Run a query (sql) with a row limit; recorded in the activity log (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/rows token A page of a table's rows (?table=, ?offset=, ?limit=) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/tables token The tables (or keys) with row counts, for the data console (in the environment {env})

databases

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/databases token List the project's databases (PostgreSQL, MariaDB, Valkey) with their state
POST /v1/orgs/{org}/projects/{project}/databases token Create a database (slug, engine, optional plan)
GET /v1/orgs/{org}/projects/{project}/databases/{db} token A database: engine, status, size, public access, latest backup and restore
PATCH /v1/orgs/{org}/projects/{project}/databases/{db} token Change a database's backup schedule (backup_hour in Vietnam time, backup_keep_days; null = the default)
DELETE /v1/orgs/{org}/projects/{project}/databases/{db} token Delete a database (?confirm=slug)
GET /v1/orgs/{org}/projects/{project}/databases/{db}/metrics token Connections and disk use over time (?range=1h|6h|24h|7d)
POST /v1/orgs/{org}/projects/{project}/databases/{db}/public token Turn access from the Internet (TLS, its own port) on or off
GET /v1/orgs/{org}/projects/{project}/databases/{db}/variables token The connection variables (DATABASE_URL or REDIS_URL, host, port, user, password)
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases token List the project's databases (PostgreSQL, MariaDB, Valkey) with their state (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/databases token Create a database (slug, engine, optional plan) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db} token A database: engine, status, size, public access, latest backup and restore (in the environment {env})
PATCH /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db} token Change a database's backup schedule (backup_hour in Vietnam time, backup_keep_days; null = the default) (in the environment {env})
DELETE /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db} token Delete a database (?confirm=slug) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/metrics token Connections and disk use over time (?range=1h|6h|24h|7d) (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/public token Turn access from the Internet (TLS, its own port) on or off (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/databases/{db}/variables token The connection variables (DATABASE_URL or REDIS_URL, host, port, user, password) (in the environment {env})

deployments

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments token List the deployments, newest first (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments token Deploy now from the service's source (optionally a commit or ref) (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments/upload token Deploy a folder: the body is a gzip tar archive of the source (zo deploy) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments/{n} token One deployment and its state (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments/{n}/diagnosis token Why a failed deployment failed: findings (rule, params, the log line) with fixes, or the assistant's explanation (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments/{n}/fixes token Apply a fix of the diagnosis ({finding, fix} indexes) and deploy again (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments/{n}/log token The build log from line ?after=N; with ?stream=1, server-sent events until the deployment ends (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/deployments/{n}/rollback token Deploy an earlier deployment's image again (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/deployments token List the deployments, newest first
POST /v1/orgs/{org}/projects/{project}/services/{service}/deployments token Deploy now from the service's source (optionally a commit or ref)
POST /v1/orgs/{org}/projects/{project}/services/{service}/deployments/upload token Deploy a folder: the body is a gzip tar archive of the source (zo deploy)
GET /v1/orgs/{org}/projects/{project}/services/{service}/deployments/{n} token One deployment and its state
GET /v1/orgs/{org}/projects/{project}/services/{service}/deployments/{n}/diagnosis token Why a failed deployment failed: findings (rule, params, the log line) with fixes, or the assistant's explanation
POST /v1/orgs/{org}/projects/{project}/services/{service}/deployments/{n}/fixes token Apply a fix of the diagnosis ({finding, fix} indexes) and deploy again
GET /v1/orgs/{org}/projects/{project}/services/{service}/deployments/{n}/log token The build log from line ?after=N; with ?stream=1, server-sent events until the deployment ends
POST /v1/orgs/{org}/projects/{project}/services/{service}/deployments/{n}/rollback token Deploy an earlier deployment's image again

dns

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/domains/{name}/records token The DNS records of a domain on ZoCloud's DNS
PUT /v1/orgs/{org}/domains/{name}/records token Replace the DNS records of a domain on ZoCloud's DNS

domains

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/domains/tlds — The top-level domains on sale with their prices
GET /v1/orgs/{org}/domain-contacts token List the registrant contacts
POST /v1/orgs/{org}/domain-contacts token Add a registrant contact (person or company, address, ID papers for .vn)
DELETE /v1/orgs/{org}/domain-contacts/{id} token Remove a registrant contact not used by a domain
GET /v1/orgs/{org}/domains token List the organisation's domains with their status and expiry
POST /v1/orgs/{org}/domains token Buy a domain (name, years, contact_id) from the wallet; .vn names get their paperwork steps
GET /v1/orgs/{org}/domains/check token Whether one name is available (?name=) and its price
GET /v1/orgs/{org}/domains/search token Search names for sale across the top-level domains (?q=), rate limited
GET /v1/orgs/{org}/domains/targets token The services a domain can point at
GET /v1/orgs/{org}/domains/{name} token A domain: status, expiry, registrant, DNS mode, pending tasks
PATCH /v1/orgs/{org}/domains/{name} token Change a domain's settings (auto-renew, DNS mode)
PUT /v1/orgs/{org}/domains/{name}/registrant token Change a domain's registrant contact
POST /v1/orgs/{org}/domains/{name}/renew token Renew a domain for some years from the wallet
POST /v1/orgs/{org}/domains/{name}/transfer-code token Ask for the transfer (auth) code; sent to the registrant

email

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/email/products — The business e-mail products on sale (Google Workspace, Microsoft 365) with their prices
GET /v1/orgs/{org}/email token List the organisation's e-mail accounts (one per domain) with their state
POST /v1/orgs/{org}/email token Order e-mail for a domain (domain, product, seats, period) from the wallet
GET /v1/orgs/{org}/email/proof token The TXT record that proves the organisation holds a domain (?domain=) before ordering
GET /v1/orgs/{org}/email/{domain} token An e-mail account: product, seats, status, DNS records to set, tasks
PATCH /v1/orgs/{org}/email/{domain} token Change an account's settings (auto-renew)
PUT /v1/orgs/{org}/email/{domain}/dkim token Set the DKIM records the provider gave
POST /v1/orgs/{org}/email/{domain}/dns/approve token Let ZoCloud set the provider's DNS records on a domain it hosts
PUT /v1/orgs/{org}/email/{domain}/proof token Set the domain ownership proof value the provider asks for
PUT /v1/orgs/{org}/email/{domain}/seats token Change the number of seats (charged or credited pro rata)
POST /v1/orgs/{org}/email/{domain}/secret token Reveal the admin account's initial password (recorded)

github

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/github/callback token Where GitHub sends the person after installing the App; links what their token proves they may
POST /v1/github/link token Link an installation to an organisation (org, code from GitHub)
POST /v1/github/webhook — GitHub's events (push, pull request, installation), signed with the App's secret
GET /v1/orgs/{org}/github token The GitHub installations linked to the organisation, and the App's install link
GET /v1/orgs/{org}/github/branches token A repository's branches (?repo=)
DELETE /v1/orgs/{org}/github/installations/{id} token Unlink a GitHub installation
GET /v1/orgs/{org}/github/repos token The repositories the linked installations can see

locations

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/locations — The locations (cells) projects can run in
GET /v1/regions — The regions (open and announced)

logs

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/logs token The service's logs (?since=, ?q=, ?stream=app|waf); with ?follow=1, server-sent events (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/logs token The service's logs (?since=, ?q=, ?stream=app|waf); with ?follow=1, server-sent events

me

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/me token The signed-in user and their organisations with roles (an organisation-scoped token sees its one organisation)
DELETE /v1/me token Delete the account (password and, with two-factor, a fresh code); organisations owned alone are closed first, one owned with other members must be passed on
GET /v1/me/export token Download the user's data as JSON (profile, organisations, token metadata); once per api.export_interval_minutes
GET /v1/me/mfa token How many recovery codes are left
DELETE /v1/me/mfa token Turn two-factor off with the password and a code
POST /v1/me/mfa/confirm token Turn two-factor on with the first code; returns the recovery codes (shown once)
POST /v1/me/mfa/enroll token Start two-factor enrolment: returns the otpauth URL to add to an authenticator app
POST /v1/me/mfa/recovery token Make new recovery codes against a fresh code (the old ones stop working)
POST /v1/me/password token Change the password (current and new); other sessions are signed out
GET /v1/me/sessions token List the signed-in sessions (address, device, method, last seen, which one is current)
DELETE /v1/me/sessions token Sign out every other session
DELETE /v1/me/sessions/{id} token Sign out one session
POST /v1/me/verify token Send the e-mail verification mail again
POST /v1/me/verify-code token Verify the e-mail address with the code from the mail

members

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/invites/accept token Accept an invitation to an organisation with its token
GET /v1/orgs/{org}/invites token List the open invitations
POST /v1/orgs/{org}/invites token Invite someone by e-mail with a role; the invitation is mailed
DELETE /v1/orgs/{org}/invites/{id} token Revoke an invitation
GET /v1/orgs/{org}/members token List the members with their roles and whether two-factor is on
PATCH /v1/orgs/{org}/members/{user} token Change a member's role
DELETE /v1/orgs/{org}/members/{user} token Remove a member
POST /v1/orgs/{org}/transfer token Pass ownership to a member with a verified e-mail (password and, with two-factor, a fresh code); the caller becomes admin

metrics

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/metrics token Requests, latency, CPU and memory series (?range=) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/metrics token Requests, latency, CPU and memory series (?range=)

notifications

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/hooks/confirm — Confirm an e-mail address of an e-mail notification hook (token from the e-mail)
GET /v1/orgs/{org}/hooks token List the notification hooks (Slack, Discord, webhooks)
POST /v1/orgs/{org}/hooks token Add a hook (kind, URL, events); a webhook's signing secret is returned once
PATCH /v1/orgs/{org}/hooks/{id} token Change a hook (events, URL, on/off)
DELETE /v1/orgs/{org}/hooks/{id} token Remove a hook
GET /v1/orgs/{org}/hooks/{id}/deliveries token The hook's latest deliveries and their results
POST /v1/orgs/{org}/hooks/{id}/test token Send a test message to the hook

oauth

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/oauth/authorize token Who the OAuth client asking for access is, and the organisations to choose from (the consent page)
POST /v1/oauth/authorize token Allow an OAuth client in one organisation; returns where to send the browser with the code

orgs

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/orgs token Create an organisation (slug, name); from a personal token or session only
GET /v1/orgs/{org} token An organisation: name, kind, status and the caller's role
DELETE /v1/orgs/{org} token Close the organisation (owner; password and, with two-factor, a fresh code): services, databases, buckets, domains and keys are removed, the ledger stays; refused while unpaid or while a domain registration is in progress
GET /v1/orgs/{org}/export token Download the organisation's data as JSON (projects with variables, databases metadata, domains, billing, tickets); once per api.export_interval_minutes
GET /v1/orgs/{org}/security token The organisation's security rules (two-factor required)
PUT /v1/orgs/{org}/security token Set the organisation's security rules (require_mfa)
GET /v1/orgs/{org}/sso token The organisation's Google Workspace domain and join rules
PUT /v1/orgs/{org}/sso token Set the Google Workspace domain whose users may join, their role, and whether Google sign-in is required
GET /v1/orgs/{org}/trust token What a waiting organisation has done towards approval (e-mail, top-up, GitHub)

plans

Route Đăng nhập · Auth Mô tả · Summary
PUT /v1/orgs/{org}/spend-limit token Set the monthly spend limit (apps pause when it is reached)
GET /v1/orgs/{org}/subscription token The organisation's plan, its limits and this month's usage
POST /v1/orgs/{org}/subscription token Change the plan (plan, period, code: a promotion code); charged from the wallet
POST /v1/orgs/{org}/subscription/cancel token Cancel the plan at the end of the period
GET /v1/orgs/{org}/subscription/quote token What changing to ?plan= and ?period= would cost now, with the best promotion (?code= a promotion code)
POST /v1/orgs/{org}/subscription/resume token Keep the plan after a cancellation
GET /v1/orgs/{org}/usage token This month's metered usage and its cost
GET /v1/plans — The public price list of plans

projects

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects token List the organisation's projects with their services
POST /v1/orgs/{org}/projects token Create a project (slug, location)
GET /v1/orgs/{org}/projects/{project} token A project with its environments and services (the canvas)
PATCH /v1/orgs/{org}/projects/{project} token Change a project's settings (name, previews, shared or fresh preview databases)
POST /v1/orgs/{org}/projects/{project}/environments token Create an environment (slug) in a project, copying production's variables
DELETE /v1/orgs/{org}/projects/{project}/envs/{env} token Delete an environment and its services (not production)
GET /v1/orgs/{org}/projects/{project}/registries token List the project's private registry credentials (host, username; never the password)
POST /v1/orgs/{org}/projects/{project}/registries token Add or replace a registry credential (host, username, password) so services may deploy private images from it
DELETE /v1/orgs/{org}/projects/{project}/registries/{host} token Remove a registry credential
GET /v1/orgs/{org}/projects/{project}/variables token The environment's shared variables (${{shared.NAME}}; ?env= for another environment)
PUT /v1/orgs/{org}/projects/{project}/variables token Set shared variables (a map); services that reference a changed one deploy again
DELETE /v1/orgs/{org}/projects/{project}/variables/{name} token Remove a shared variable

reference

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/openapi.json — This document: the API as OpenAPI 3.1

security

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/security token The service's protection: web application firewall mode, exclusions, blocked countries and addresses (in the environment {env})
PUT /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/security token Set the service's protection (firewall mode, silenced rules, blocked countries and addresses) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/security token The service's protection: web application firewall mode, exclusions, blocked countries and addresses
PUT /v1/orgs/{org}/projects/{project}/services/{service}/security token Set the service's protection (firewall mode, silenced rules, blocked countries and addresses)

services

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services token Create a service (slug, kind; source: repo and branch, image, or a later upload) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service} token A service: source, settings, latest deployment, URL, volume (in the environment {env})
PATCH /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service} token Change a service's settings (source, build and start commands, port, health check, resources, cron schedule) (in the environment {env})
DELETE /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service} token Delete a service (?confirm=slug) (in the environment {env})
PUT /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/autoscale token Set CPU autoscaling (min, max instances, target) (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/scale token Set the number of instances (in the environment {env})
PUT /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/sleep token Turn sleeping when idle on or off (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/services token Create a service (slug, kind; source: repo and branch, image, or a later upload)
GET /v1/orgs/{org}/projects/{project}/services/{service} token A service: source, settings, latest deployment, URL, volume
PATCH /v1/orgs/{org}/projects/{project}/services/{service} token Change a service's settings (source, build and start commands, port, health check, resources, cron schedule)
DELETE /v1/orgs/{org}/projects/{project}/services/{service} token Delete a service (?confirm=slug)
PUT /v1/orgs/{org}/projects/{project}/services/{service}/autoscale token Set CPU autoscaling (min, max instances, target)
POST /v1/orgs/{org}/projects/{project}/services/{service}/scale token Set the number of instances
PUT /v1/orgs/{org}/projects/{project}/services/{service}/sleep token Turn sleeping when idle on or off

status

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/health — The control plane's health for an outside watchdog: 200 when the database takes writes and background work runs, 503 otherwise
GET /v1/status — The public status page: components, notices, uptime
POST /v1/status/confirm — Confirm a status subscription (token from the e-mail)
POST /v1/status/subscribe — Subscribe an e-mail address to status notices (a confirmation link is sent)
POST /v1/status/unsubscribe — Unsubscribe from status notices (token from any notice e-mail)

support

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/tickets token List the organisation's support tickets
POST /v1/orgs/{org}/tickets token Open a ticket (subject, category, body)
POST /v1/orgs/{org}/tickets/attachments token Upload a file to attach to a ticket message (support.attachments limits); returns the id to pass in attachments
GET /v1/orgs/{org}/tickets/{n} token A ticket and its messages
GET /v1/orgs/{org}/tickets/{n}/attachments/{aid} token Download a ticket attachment
POST /v1/orgs/{org}/tickets/{n}/close token Close a ticket
POST /v1/orgs/{org}/tickets/{n}/messages token Reply to a ticket

templates

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/templates — The templates one can deploy from

tokens

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/me/tokens token List the personal access tokens (name, prefix, organisation scope, read-only, last use)
POST /v1/me/tokens token Create a personal access token (name, days; optional org slug to limit it to one organisation, read_only); the token is returned once; from a session only
DELETE /v1/me/tokens/{id} token Revoke a personal access token

variables

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/variables token The service's variables (decrypted) and their version (in the environment {env})
PATCH /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/variables token Set variables (name: value; an empty value removes one); applies from the next deployment (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/services/{service}/variables token The service's variables (decrypted) and their version
PATCH /v1/orgs/{org}/projects/{project}/services/{service}/variables token Set variables (name: value; an empty value removes one); applies from the next deployment

volumes

Route Đăng nhập · Auth Mô tả · Summary
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/volume token Attach a volume (mount path, size) (in the environment {env})
PATCH /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/volume token Grow the volume (in the environment {env})
DELETE /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/volume token Detach and delete the volume (?confirm=slug) (in the environment {env})
GET /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/volume/backups token List the volume's backups (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/volume/backups token Back the volume up now (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/envs/{env}/services/{service}/volume/backups/{backup}/restore token Restore the volume from a backup (the service restarts) (in the environment {env})
POST /v1/orgs/{org}/projects/{project}/services/{service}/volume token Attach a volume (mount path, size)
PATCH /v1/orgs/{org}/projects/{project}/services/{service}/volume token Grow the volume
DELETE /v1/orgs/{org}/projects/{project}/services/{service}/volume token Detach and delete the volume (?confirm=slug)
GET /v1/orgs/{org}/projects/{project}/services/{service}/volume/backups token List the volume's backups
POST /v1/orgs/{org}/projects/{project}/services/{service}/volume/backups token Back the volume up now
POST /v1/orgs/{org}/projects/{project}/services/{service}/volume/backups/{backup}/restore token Restore the volume from a backup (the service restarts)

admin

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/audit nhân viên · staff Staff: the audit log across organisations (?actor=, ?action=, ?before=)
GET /v1/admin/auth/google nhân viên · staff Staff: ZoCloud's Google OAuth client (ID and redirect URI)
PUT /v1/admin/auth/google nhân viên · staff Staff: set the Google OAuth client ID and secret
GET /v1/admin/changeplans nhân viên · staff Staff: the pending change plans (wallet credits and other risky changes)
POST /v1/admin/changeplans/credit nhân viên · staff Staff: propose a wallet credit as a change plan
POST /v1/admin/changeplans/{id}/apply nhân viên · staff Staff: apply an approved change plan
POST /v1/admin/changeplans/{id}/approve nhân viên · staff Staff: approve a change plan (another staff member than its proposer)
POST /v1/admin/changeplans/{id}/reject nhân viên · staff Staff: reject a change plan
GET /v1/admin/github nhân viên · staff Staff: ZoCloud's GitHub App (whether it exists, its name)
DELETE /v1/admin/github nhân viên · staff Staff: forget the GitHub App
PUT /v1/admin/me/telegram nhân viên · staff Staff: set one's own Telegram username for alerts (empty removes it)
GET /v1/admin/oncall nhân viên · staff Staff: the on-call shifts and the staff with their Telegram usernames
POST /v1/admin/oncall nhân viên · staff Staff: add an on-call shift (who, from, to)
DELETE /v1/admin/oncall/{id} nhân viên · staff Staff: remove an on-call shift
GET /v1/admin/overview nhân viên · staff Staff: counts for the console's front page (organisations, nodes, tickets, incidents)
GET /v1/admin/settings nhân viên · staff Staff: every setting with its value and default
PUT /v1/admin/settings/{key} nhân viên · staff Staff: set a setting (validated by its definition)
GET /v1/admin/staff nhân viên · staff Staff: the staff members and their roles
PUT /v1/admin/staff nhân viên · staff Staff: give or take a staff role (email, role)
GET /v1/admin/suggestions nhân viên · staff Staff: the Advisor's open suggestions for operators
GET /v1/admin/templates nhân viên · staff Staff: the deploy templates, hidden ones too
PUT /v1/admin/templates/{code} nhân viên · staff Staff: create or change a template
GET /v1/github/manifest nhân viên · staff Staff: the manifest to create the GitHub App with, and GitHub's form address

admin-ai

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/ai/models nhân viên · staff Staff: the models with their provider, cost and sale prices
PUT /v1/admin/ai/models/{id...} nhân viên · staff Staff: set a model's provider, prices and visibility
GET /v1/admin/ai/providers nhân viên · staff Staff: the upstream providers (keys write-only)
PUT /v1/admin/ai/providers/{code} nhân viên · staff Staff: set a provider's base URL, key and whether it is active

admin-billing

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/einvoices nhân viên · staff Staff: the e-invoice queue (?done=1 for the issued ones)
GET /v1/admin/einvoices/providers nhân viên · staff Staff: the e-invoice providers and which is active
POST /v1/admin/einvoices/{id}/issued nhân viên · staff Staff: record an e-invoice issued by hand in the provider's portal (number, link)
POST /v1/admin/einvoices/{id}/resolve nhân viên · staff Staff: close a failed e-invoice with a status and note
POST /v1/admin/einvoices/{id}/retry nhân viên · staff Staff: send an e-invoice to the provider again
GET /v1/admin/finance/categories nhân viên · staff Staff: the cost categories (setting finance.cost_categories)
GET /v1/admin/finance/costs nhân viên · staff Staff (finance): the costs recorded in a month (?month=YYYY-MM)
POST /v1/admin/finance/costs nhân viên · staff Staff (finance): record a cost (date, category, supplier, amount before VAT, VAT, invoice number)
DELETE /v1/admin/finance/costs/{id} nhân viên · staff Staff (finance): remove a cost from the reports (kept, marked deleted)
GET /v1/admin/finance/recurring nhân viên · staff Staff (finance): the costs recorded every month
POST /v1/admin/finance/recurring nhân viên · staff Staff (finance): add a cost recorded every month on a day
PUT /v1/admin/finance/recurring/{id} nhân viên · staff Staff (finance): change or stop a recurring cost (for the months not recorded yet)
GET /v1/admin/finance/report nhân viên · staff Staff (finance): the profit and loss by month (?from=YYYY-MM&to=YYYY-MM): revenue by line, discounts, refunds, costs, fees, cash in, VAT, top customers
GET /v1/admin/finance/sales nhân viên · staff Staff (finance): the sales book of a month (?month=YYYY-MM): paid orders and monthly charges
GET /v1/admin/finance/summary nhân viên · staff Staff (finance): MRR, subscribers, unpaid renewals, customers' wallets, VAT payable, this month so far
GET /v1/admin/gateways nhân viên · staff Staff: the payment gateways and whether their keys are set
PUT /v1/admin/gateways/{gw} nhân viên · staff Staff: configure a payment gateway (keys are write-only)
GET /v1/admin/payments nhân viên · staff Staff: recent payments across organisations
POST /v1/admin/payments/{id}/confirm nhân viên · staff Staff: confirm a payment seen to arrive (a bank transfer with a wrong message)
GET /v1/admin/plans nhân viên · staff Staff: the plans with their limits and prices, hidden ones too
PUT /v1/admin/plans/{code} nhân viên · staff Staff: create or change a plan (names, limits, visibility)
POST /v1/admin/plans/{code}/prices nhân viên · staff Staff: set a plan's prices from a date
GET /v1/admin/promotions nhân viên · staff Staff: the promotions (a percentage off plans) with how much they were used
POST /v1/admin/promotions nhân viên · staff Staff (plans): create a promotion: percent, plans, periods, code or automatic, dates, cycles, limits
PUT /v1/admin/promotions/{id} nhân viên · staff Staff (plans): change, end or turn off a promotion
GET /v1/admin/promotions/{id}/uses nhân viên · staff Staff: the orders a promotion took money off

admin-blog

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/blog/posts nhân viên · staff Staff: list the blog's posts, drafts too
POST /v1/admin/blog/posts nhân viên · staff Staff: create a post (draft)
GET /v1/admin/blog/posts/{id} nhân viên · staff Staff: a post with its Markdown
PUT /v1/admin/blog/posts/{id} nhân viên · staff Staff: save a post (publishing it when its status says so)
DELETE /v1/admin/blog/posts/{id} nhân viên · staff Staff: delete a post
POST /v1/admin/blog/preview nhân viên · staff Staff: render Markdown as the blog would

admin-domains

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/domains/costs nhân viên · staff Staff: the registrar's current cost prices per top-level domain
GET /v1/admin/domains/registrar nhân viên · staff Staff: the registrar API account (secrets hidden) and its mode (sandbox, live)
PUT /v1/admin/domains/registrar nhân viên · staff Staff: set the registrar API account
POST /v1/admin/domains/registrar/test nhân viên · staff Staff: call the registrar to check the account
GET /v1/admin/domains/tasks nhân viên · staff Staff: the registrar tasks waiting for a person (.vn papers, transfers, failures)
POST /v1/admin/domains/tasks/{id}/ask nhân viên · staff Staff: ask the customer for something on a task (a message)
GET /v1/admin/domains/tasks/{id}/auth-code nhân viên · staff Staff: the transfer code of a task's domain (recorded)
POST /v1/admin/domains/tasks/{id}/done nhân viên · staff Staff: mark a registrar task done
POST /v1/admin/domains/tasks/{id}/fail nhân viên · staff Staff: fail a registrar task with a reason (the customer is told)
POST /v1/admin/domains/tasks/{id}/retry nhân viên · staff Staff: run a failed registrar task again
GET /v1/admin/domains/tlds nhân viên · staff Staff: the top-level domains with cost and sale prices, hidden ones too
PUT /v1/admin/domains/tlds/{tld} nhân viên · staff Staff: set a top-level domain's prices and visibility

admin-email

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/email/access nhân viên · staff Staff: whether the providers' API credentials are set
PUT /v1/admin/email/google-key nhân viên · staff Staff: set the Google reseller service account key
PUT /v1/admin/email/ion-token nhân viên · staff Staff: set the TD SYNNEX Ion API token
GET /v1/admin/email/products nhân viên · staff Staff: the e-mail products with cost and sale prices
PUT /v1/admin/email/products/{code} nhân viên · staff Staff: set an e-mail product's prices and visibility
GET /v1/admin/email/tasks nhân viên · staff Staff: the provisioning tasks waiting for a person
POST /v1/admin/email/tasks/{id}/done nhân viên · staff Staff: mark a provisioning task done
POST /v1/admin/email/tasks/{id}/fail nhân viên · staff Staff: fail a provisioning task with a reason
POST /v1/admin/email/tasks/{id}/retry nhân viên · staff Staff: run a failed provisioning task again
POST /v1/admin/email/test/{provider} nhân viên · staff Staff: call a provider's API to check the credentials

admin-incidents

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/incidents nhân viên · staff Staff: list incidents (?status=, ?limit=)
POST /v1/admin/incidents nhân viên · staff Staff: open an incident by hand (title, severity, body)
GET /v1/admin/incidents/counts nhân viên · staff Staff: how many incidents are open, acknowledged, resolved
GET /v1/admin/incidents/{id} nhân viên · staff Staff: an incident with its events and notes
POST /v1/admin/incidents/{id}/ack nhân viên · staff Staff: acknowledge an incident
POST /v1/admin/incidents/{id}/notes nhân viên · staff Staff: add a note to an incident
POST /v1/admin/incidents/{id}/resolve nhân viên · staff Staff: resolve an incident
GET /v1/admin/status/notices nhân viên · staff Staff: the status page's notices (incidents and maintenance)
POST /v1/admin/status/notices nhân viên · staff Staff: publish a notice on the status page
DELETE /v1/admin/status/notices/{id} nhân viên · staff Staff: remove a notice
POST /v1/admin/status/notices/{id}/updates nhân viên · staff Staff: add an update to a notice (state, text)
GET /v1/admin/status/subscribers nhân viên · staff Staff: how many confirmed status subscribers there are

admin-infra

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/alerts nhân viên · staff Staff: the firing alerts and the alerting setup
PUT /v1/admin/alerts/telegram nhân viên · staff Staff: set the Telegram bot and chat alerts go to
POST /v1/admin/alerts/test nhân viên · staff Staff: send a test alert
GET /v1/admin/backups nhân viên · staff Staff: the backup stores, the latest backups and drills
POST /v1/admin/backups/drill nhân viên · staff Staff: run a restore drill now
POST /v1/admin/backups/setup nhân viên · staff Staff: set the control plane's backups up again
PUT /v1/admin/backups/wasabi nhân viên · staff Staff: set the offsite (Wasabi) credentials and bucket, then set backups up
GET /v1/admin/capacity nhân viên · staff Staff: capacity per pool and node (CPU, memory, disk reserved and free)
PUT /v1/admin/cells/{id} nhân viên · staff Staff: name, open or close a location
GET /v1/admin/certs nhân viên · staff Staff: the platform's certificates and their expiry
POST /v1/admin/certs/renew nhân viên · staff Staff: renew a certificate now
GET /v1/admin/dns nhân viên · staff Staff: the authoritative DNS servers and zones
GET /v1/admin/locations nhân viên · staff Staff: the locations (cells), with the hidden ones
GET /v1/admin/nodes nhân viên · staff Staff: the nodes with roles, status, versions and health
POST /v1/admin/nodes/token nhân viên · staff Staff: make a one-time join token for a new node (name, roles); returns the install command
POST /v1/admin/nodes/{id}/cordon nhân viên · staff Staff: stop (on) or allow (off) new work on a node
POST /v1/admin/nodes/{id}/drain nhân viên · staff Staff: move a cordoned node's services elsewhere
POST /v1/admin/nodes/{id}/ping nhân viên · staff Staff: ask a node's agent to answer now
POST /v1/admin/nodes/{id}/reboot nhân viên · staff Staff: reboot a node
GET /v1/admin/nodes/{id}/removable nhân viên · staff Staff: what still keeps a node from being removed
POST /v1/admin/nodes/{id}/remove nhân viên · staff Staff: remove a node from the cluster
PUT /v1/admin/nodes/{id}/roles nhân viên · staff Staff: change a node's roles
GET /v1/admin/regions nhân viên · staff Staff: the regions, with the hidden ones
PUT /v1/admin/regions/{id} nhân viên · staff Staff: name, order, announce or hide a region
GET /v1/admin/releases nhân viên · staff Staff: the releases, the agents' versions per node
POST /v1/admin/releases/push nhân viên · staff Staff: roll a release out to the nodes
GET /v1/admin/standby nhân viên · staff Staff: the database servers, their standbys and recent failovers
POST /v1/admin/standby nhân viên · staff Staff: make a node the standby of a database server (primary, node)
POST /v1/admin/standby/{node}/failover nhân viên · staff Staff: fail a database server over to its standby now
POST /v1/admin/standby/{node}/promote nhân viên · staff Staff: promote a standby
POST /v1/admin/standby/{node}/resync nhân viên · staff Staff: copy the primary to the standby again

admin-mail

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/mail/outbox nhân viên · staff Staff: the recent queued and failed mails
POST /v1/admin/mail/outbox/{id}/retry nhân viên · staff Staff: send a failed mail again
GET /v1/admin/mail/smtp nhân viên · staff Staff: the outgoing mail (SMTP) settings, password hidden
PUT /v1/admin/mail/smtp nhân viên · staff Staff: set the outgoing mail server
GET /v1/admin/mail/templates nhân viên · staff Staff: the e-mail templates in both languages
PUT /v1/admin/mail/templates/{key}/{lang} nhân viên · staff Staff: edit a template's subject and body in one language
POST /v1/admin/mail/test nhân viên · staff Staff: send a template to an address now (to, template, lang)

admin-orgs

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/orgs nhân viên · staff Staff: list organisations (?status=, ?q=)
GET /v1/admin/orgs/{slug} nhân viên · staff Staff: an organisation's details, members, trust, wallet, notes
POST /v1/admin/orgs/{slug}/credit nhân viên · staff Staff: propose a wallet credit (amount, reason; a change plan another staff member approves)
POST /v1/admin/orgs/{slug}/members/{email}/mfa-reset nhân viên · staff Staff: remove a member's two-factor and sign their sessions out (identity checked through Support first; staff's own code required)
POST /v1/admin/orgs/{slug}/notes nhân viên · staff Staff: add an internal note to an organisation
POST /v1/admin/orgs/{slug}/plan nhân viên · staff Staff: put an organisation on a plan without charging it
POST /v1/admin/orgs/{slug}/status nhân viên · staff Staff: approve, suspend or reactivate an organisation (status, reason)

admin-support

Route Đăng nhập · Auth Mô tả · Summary
GET /v1/admin/chats nhân viên · staff Staff: the latest Ask ZoCloud conversations (members', or with ?site=1 the website's)
GET /v1/admin/chats/{id} nhân viên · staff Staff: a conversation's messages, with what ZoCloud proposed
GET /v1/admin/tickets nhân viên · staff Staff: list tickets across organisations (?status=, ?q=)
GET /v1/admin/tickets/{n} nhân viên · staff Staff: a ticket with its messages, internal notes and the organisation's context
PATCH /v1/admin/tickets/{n} nhân viên · staff Staff: change a ticket's status, priority or assignee
POST /v1/admin/tickets/{n}/attachments token Staff: upload a file to attach to a reply or note
GET /v1/admin/tickets/{n}/attachments/{aid} nhân viên · staff Staff: download a ticket attachment
POST /v1/admin/tickets/{n}/messages nhân viên · staff Staff: answer a ticket, or add an internal note (internal)