api-keys

Create a project API key

Changed on

The scope defaults to admin when omitted.

post/projects/{project_id}/api-keys

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/api-keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Request body

expires_in_days30 | 90 | 365 | null nullable

Lifetime in days. Use null for no expiry.

namestring required
scope'read' | 'write' | 'admin'

Access tier. When omitted, defaults to admin for backward compatibility.

Response

Created

created_atstring date-time required
expires_atstring date-time nullable required
idstring required
last_used_atstring date-time nullable required
namestring required
prefixstring required
revoked_atstring date-time nullable required
scope'read' | 'write' | 'admin' required
masked_valuestring required
tokenstring required

Example response

{
  "id": "key_a00000000000000000000000",
  "prefix": "bsb_key_live_xxxxxxxx",
  "token": "bsb_key_live_..."
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status