API keys

3 operations · all resources

What this covers#

Project-scoped machine keys. The plaintext is returned once, at creation, and never again; a key carries an explicit scope set and cannot be widened after the fact.

Every example below runs as written once these are exported:

export DVAARIK_TOKEN="<account access token>"   # console session, from POST /console/auth/login
export KEY_ID="<uuid>"

A <value> inside a JSON body is a value you supply. Responses are JSON; every error body is { "detail": … }. Each schema is expanded once per page, where it first appears.

Account door errors#

Operations — account session#

The same resource through the console door. These are what the web console calls; both doors return the same shapes.

GET /v2/api-keys#

List the project's keys: prefix, scopes and usage timestamps, never the plaintext.

ApiKeyInfo#

Plus the account-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/v2/api-keys?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /v2/api-keys#

Mint a project key with an explicit scope set. This is the only response that ever carries the plaintext.

Request body: CreateV2KeyRequest.

CreateV2KeyRequest#

Canonical v2 create with a required, explicit permission set.

CreatedKeyResponse#

The ONLY response that ever carries the plaintext.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/api-keys" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "backend-server",
    "project_id": "<project uuid>",
    "scopes": [
      "voice:read",
      "voice:write"
    ]
  }'

DELETE /v2/api-keys/{key_id}#

Revoke a key immediately. Revocation cannot be undone; mint a replacement first if the key is live.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X DELETE "https://api.developers.dvaarik.com/v2/api-keys/$KEY_ID" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"