API overview

Your workspace, from code

A REST API for your own deployment, reached with a named API key. Everything below is generated from the same OpenAPI document the server enforces.

99operations
18areas
33scopes a key can carry
25keys one person may hold
Authentication

One named key, sent on every request

  • Create a key under Settings › API keys in the workspace. It starts with obk_ and is shown once.
  • A key acts as the person who created it, never more: their current role and access are checked on every request.
  • Each key carries only the scopes chosen when it was made, and can be given an expiry.
  • No key can create or revoke keys.
curl -H "Authorization: Bearer $api_key" \
  https://<your-deployment>/api/me

Limits

Limits
Failed key attempts from one address, per window20
Failed key attempts from all addresses together, per window500
Window length, in minutes10
Longest expiry a key can be given, in days3650

Past a limit the server answers 429 with a Retry-After header. Conventions for scripts, paging and filters are on the developer page.