API Access

Create and revoke API keys, set per-key quotas, and view API usage.

Console	API Access
API	POST /v1/admin/gateway/keys · POST /v1/admin/gateway/keys/{id}/revoke · PUT /v1/admin/gateway/keys/{id}/quota · GET /v1/admin/gateway/usage
Mutating?	Keys and quotas — yes

Prerequisites

• Signed in as it_admin or app_owner for create / revoke / quota
• Any role can view usage

Auditor

Creating, revoking, or changing quotas as auditor returns 403 RES-ADMIN-403.

Create an API key

1. Open API Access.
2. Choose Create (or equivalent).
3. Complete the key creation dialog and submit (POST /v1/admin/gateway/keys).
4. Copy the secret immediately if the console shows it once — store it in your organisation’s secret store.

Verify

• The new key appears in the key list.
• A test call with the key is accepted by the gateway (coordinate the exact route with your integration).

Revoke an API key

1. On API Access, select the key.
2. Choose Revoke (POST /v1/admin/gateway/keys/{id}/revoke).
3. Confirm the prompt.

Verify

• Key status shows revoked.
• Subsequent calls with that key are rejected.

Set per-key quotas

1. Select the key.
2. Open quota settings.
3. Set the quota values and save (PUT /v1/admin/gateway/keys/{id}/quota).

Verify

• Quota fields reload with the saved values.
• Usage near the limit behaves according to your policy (throttled/rejected — confirm in your environment; these docs do not publish throughput numbers).

View API usage

1. On API Access, open usage (GET /v1/admin/gateway/usage).
2. Review usage for the keys/time range shown.

Verify

• Usage data loads without error.

If it fails

Symptom	Action
403 on create/revoke/quota	Sign in with a mutating role
Lost key secret	Revoke and create a new key — secrets are not recoverable from these docs’ described flow
Usage empty	No traffic yet, or filters exclude the window — widen the view