BRbridge
API Keys

Describe the calling API key

Return metadata about the API key authenticating this request, including its scopes. The plaintext secret is never returned.

get/api_keys/whoami

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/api_keys/whoami
  • Auth
    API key in header Api-Key

Response

Metadata describing the calling API key.

idstring uuid required

The unique identifier for this API key.

type'Public' | 'Private' required

Whether the key was created programmatically (Private) or via the Dashboard (Public).

owner_type'Developer' required

The type of entity that owns the key. Always Developer.

owner_idstring uuid required

The developer ID that owns the key.

prefix'sk-live' | 'sk-test' required

The environment prefix of the key. sk-live in production, sk-test in sandbox.

last_4string required

The last four characters of the key, shown alongside the prefix for disambiguation in audit logs.

state'Active' | 'Deleted' required

Lifecycle state of the key.

created_atstring date-time required
updated_atstring date-time required
scopesstring[] required

The scopes authorized on this key. A single-element list containing bridge:api_unrestricted denotes an unrestricted key (all standard scopes). Any other list denotes a scoped key.

namestring

The human-readable label for this key, if one was provided at creation.

Changes

No recorded changes to this operation across all 2 revisions of this API.