Skip to main content
Every endpoint except the public sign-in routes requires credentials. There are two ways to get them. Create a key under Settings → API keys, or Access management → Keys for administrators. See API keys. Send it in the X-API-Key header on every request:
API keys are scoped to a workspace and can be revoked individually. See API key scopes for what a key is allowed to reach.

Login tokens (interactive sessions)

For short-lived programmatic sessions, exchange an email and password for a JWT:
The response contains an access_token. Send it as Authorization: Bearer <access_token> on subsequent requests. Tokens expire after the configured TTL; refresh by logging in again. GET /api/auth/me returns the current user profile and roles.

API key scopes

Every key carries a list of scopes. On each request the platform derives the scope that route requires and checks the key against it, so a key can only reach the surfaces it was issued for.

The scope list

* used to expand to the Data Security scopes alone, so a key labelled Full access carried no Runtime Security authority and could not call the firewall. It now covers both halves of the platform. If you worked around this by minting a second runtime:* key, you no longer need it, though the extra key keeps working.
Only the values above are honoured. Category wildcards other than runtime:* (datasets:*, for example) are not valid scopes and are never recognised, at creation or on a request.

Which scope a route requires

The required scope is derived from the path and the method. Reads are GET, HEAD, and OPTIONS; everything else counts as a write. The /results row is matched first, so a results path wins over the scans or datasets rows it might otherwise fall into.
The catch-all row used to return the read scope whatever the method, so a key issued for telemetry could also mint and revoke enrollment tokens, revoke and rebind devices, create and delete Apps, and rewrite endpoint policy. Writes on that surface now require runtime:config:write. Audit any automation that mutates devices, Apps, enrollment tokens or endpoint policy with a runtime:events:read key: it will start returning 403 with API key missing required scope: runtime:config:write.

A key can never exceed its creator

Each scope is backed by a permission the creating user must hold, so minting a key is never a way to gain access: runtime:* is granted only when the creator can exercise all four runtime: scopes, and * only when they can exercise every scope in the table. Asking for a scope you do not hold returns 403.

Creating a key

Omit scopes entirely and the key is issued with the widest set you are personally authorized for. It used to default to *, which meant anyone holding less than full access was refused for a request they never made. Do not send a literal "*" unless you really hold every scope; send [] or omit the field.
GET /api/api-keys/scopes returns the scope list with labels, which is what the console renders.

Next steps

  • Errors: what a 401 or 403 looks like.
  • API keys: create and revoke keys in the console.