API Keys

Manage API keys programmatically. API keys authenticate all requests to the ARQERA API.

List API Keys

Retrieve all API keys for your account.

GET /api/v1/api-keys

Example

curl -s "https://api.arqera.io/api/v1/api-keys" \
  -H "X-API-Key: $ARQERA_API_KEY"

Response

{
  "keys": [
    {
      "id": "key_a1b2c3d4",
      "name": "production",
      "prefix": "ak_7f3a****",
      "environment": "production",
      "scopes": ["governance:evaluate", "evidence:read"],
      "created_at": "2026-01-15T10:00:00Z",
      "expires_at": "2026-04-15T10:00:00Z",
      "last_used_at": "2026-02-22T09:45:00Z"
    },
    {
      "id": "key_e5f6g7h8",
      "name": "sandbox-dev",
      "prefix": "ak_2b4d****",
      "environment": "sandbox",
      "scopes": ["governance:evaluate", "evidence:read", "evidence:write"],
      "created_at": "2026-02-01T14:30:00Z",
      "expires_at": "2026-05-01T14:30:00Z",
      "last_used_at": "2026-02-22T10:30:00Z"
    }
  ],
  "total": 2
}

note

The full API key value is never returned after creation. Only the prefix is shown for identification.

---

Create API Key

Create a new API key.

POST /api/v1/api-keys

Request Body

{
  "name": "ci-pipeline",
  "environment": "sandbox",
  "scopes": ["governance:evaluate", "evidence:read"]
}

Field	Type	Required	Description
name	string	Yes	A descriptive name for the key
environment	string	Yes	"sandbox" or "production"
scopes	string[]	No	Permission scopes (defaults to all scopes)

Response

{
  "id": "key_i9j0k1l2",
  "name": "ci-pipeline",
  "key": "ak_9f2a7b3c4e1d8f6a5b0c3e7d9f2a1b4c",
  "environment": "sandbox",
  "scopes": ["governance:evaluate", "evidence:read"],
  "created_at": "2026-02-22T11:00:00Z",
  "expires_at": "2026-05-22T11:00:00Z"
}

caution

The key field is returned only once at creation time. Store it securely. If you lose the key, you must create a new one.

---

Revoke API Key

Permanently revoke an API key. This action cannot be undone.

DELETE /api/v1/api-keys/{key_id}

Example

curl -X DELETE "https://api.arqera.io/api/v1/api-keys/key_a1b2c3d4" \
  -H "X-API-Key: $ARQERA_API_KEY"

Response

{
  "id": "key_a1b2c3d4",
  "revoked": true,
  "revoked_at": "2026-02-22T11:05:00Z"
}

---

Key Properties

Property	Description
Format	All keys start with ak_ followed by 32 hex characters
Expiry	90 days by default (configurable for Enterprise)
Environments	sandbox (development) or production (live traffic)
Rotation notification	Email sent 24 hours before expiration

Available Scopes

Scope	Description
governance:evaluate	Evaluate actions against governance laws
evidence:read	Read evidence artifacts
evidence:write	Create evidence artifacts
usage:read	View usage and billing data
keys:manage	Create and revoke API keys