api-keys

Revoke an API key

Changed on
delete/api-keys/{key_id}

Request

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

Query parameters

projectstring

Query-parameter equivalent of the X-Bisibility-Project header for personal-access-token project selection. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project.

Headers

Bisibility-API-Version'v1'

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

X-Bisibility-Projectstring

Project public ID (prj_...) targeted by this personal-access-token request. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project. Project API keys and paths that already carry a project ID ignore it.

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).

Response

JSON response

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

Example response

{
  "id": "key_a00000000000000000000000",
  "prefix": "bsb_key_live_xxxxxxxx"
}

Changes

  • a6e1ec0dec82Revision changes
    • 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