API 参考
服务与账户
检查服务是否在线,查看哪些模块已可用于生产,导出工作区的数据,以及读取或删除您自己的账户。
路由摘要和字段名称均以英文撰写,本页与文件中都是如此。
/api/health
GET /api/health
Health check, for uptime monitors
认证
无:公开
应答
200 · 429 · 503/api/v1/system
GET /api/v1/system/modules
Which modules are production-grade, beta or experimental
认证
API 密钥
密钥作用域
usage:read参数
maturity应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/export
GET /api/v1/export
The workspace's data, for portability (GDPR art. 20)
认证
API 密钥
密钥作用域
journal:read参数
format · tables · offset · limit应答
200 · 401 api_key_missing, api_key_invalid · 403 api_key_role_denied, api_key_scope_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailable/api/v1/me
GET /api/v1/me
Your personal data (GDPR art. 15) — signed in, never an API key
认证
已登录的会话(控制台)
参数
cursor应答
200 · 400 validation_failed · 401 session_required, session_expired, mfa_challenge_required · 429 · 500 internal_error · 503 service_unavailableDELETE /api/v1/me
Erase your account (GDPR art. 17) — signed in, never an API key
认证
已登录的会话(控制台)
应答
200 · 401 session_required, session_expired, mfa_challenge_required · 409 legal_hold_active · 429 · 500 internal_error · 502 billing_cancel_failed · 503 billing_cancel_failed, service_unavailable