Pair API key - Fireblocks Developer Docs

PUT

cosigners

{cosignerId}

api_keys

{apiKeyId}

TypeScript

const response: Promise<FireblocksResponse<PairApiKeyResponse>> = fireblocks.cosignersBeta.pairApiKey(cosignersBetaApiPairApiKeyRequest);

{
  "id": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "callbackHandler": {
    "url": "https://example.com/callback-handler",
    "publicKey": "-----BEGIN PUBLIC KEY-----\n... truncated ...-----END PUBLIC KEY-----",
    "cert": "-----BEGIN CERTIFICATE-----\n... truncated ...\n-----END CERTIFICATE-----"
  }
}

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Path Parameters

cosignerId

string<uuid>

required

The unique identifier of the cosigner

apiKeyId

string

required

The unique identifier of the API key

Body

application/json

callbackHandler

object

Show child attributes

Response

The API key object to be paired

string<uuid>

required

The unique identifier of the API key

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

callbackHandler

object

Show child attributes

Unpair API keyUnpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin.

⌘I

TypeScript

const response: Promise<FireblocksResponse<PairApiKeyResponse>> = fireblocks.cosignersBeta.pairApiKey(cosignersBetaApiPairApiKeyRequest);

{
  "id": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "callbackHandler": {
    "url": "https://example.com/callback-handler",
    "publicKey": "-----BEGIN PUBLIC KEY-----\n... truncated ...-----END PUBLIC KEY-----",
    "cert": "-----BEGIN CERTIFICATE-----\n... truncated ...\n-----END CERTIFICATE-----"
  }
}