keys

Attach Key

Bind a bp_ key to the authenticated Clerk account.

Returns {ok: true, account_id, key_prefix, name} on success. Errors:

  • 401 AUTH_REQUIRED -- no Clerk session resolvable from the request (cookie, dev override header, or query param).
  • 400 KEY_NOT_FOUND -- the bp_ key isn't in our DB.
  • 409 KEY_ALREADY_ATTACHED -- the key is already bound to a DIFFERENT account. Re-attaching to the same account is a noop and returns 200.
post/v1/keys/attach

Request

  • Base URL: https://api.bitpoort.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.bitpoort.com/v1/keys/attach
  • Auth: none required

Request body

api_keystring required

The bp_ API key to bind.

namestring nullable

Optional friendly name for the dashboard. Defaults to the existing api_keys.name.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.