POST/keys

Create API Key

Generate a new API key for your tenant. The full key is returned once — save it immediately.

🔒Scope required:admin

Body Parameters

Parameter	Type	Required	Description
`name`	string	✅	Friendly name for the key (e.g. “CI/CD Pipeline”)
`scopes`	string[]	No	Allowed scopes. Defaults to `["read"]`
`expiresInDays`	integer	No	Days until expiry. `null` = never expires

Request Example

curl -X POST https://api.scootsign.com/api/v1/keys \
  -H "X-API-Key: aram_ent_ADMIN_KEY..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CI/CD Pipeline",
    "scopes": ["read", "write"],
    "expiresInDays": 90
  }'

Response

200 OK

{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI/CD Pipeline",
    "key": "aram_ent_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "prefix": "aram_ent_a1b2",
    "scopes": ["read", "write"],
    "expiresAt": "2026-06-01T00:00:00.000Z",
    "warning": "Save this key now. It will not be shown again."
  }
}

⚠️ The key field is only returned in this response. It is SHA-256 hashed before storage and cannot be retrieved later.