Skip to navigation

List API keys

Read-only and masked: each key’s name, type, scopes, expiry and last use, never the secret. It lets an agent see what it holds and lets the dashboard show the same list. Keys are created, rolled and revoked by signed-in people in the dashboard, not through the API.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

agentbooleanOptional
Only agent keys, or only keys that are not agent keys.
statusenumOptional
Only keys with this status.
Allowed values:
limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

Response

A page of keys.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error