Cancel a Key

DELETE

https://api.cobre.co/v1/accounts/{acct_id}/keys/{key_id}

This endpoint allows the cancellation of a Cobre key.

Once the cancellation is executed, the key will move to an Unregistered state. This state prevents the key from being used in any type of operation, and the client will no longer be able to reactivate it.

See Cobre Keys with Bre-B guide

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200Success

application/json

Example response

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠429Too Many Requests

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://api.cobre.co/v1/accounts//keys/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - cancel a key

{
    "id": "key_TQjvIO8UFf1bv81",
    "key_value": "@CB82VOHMT",
    "source_id": "acc_HxYC73icAX",
    "source": null,
    "alias": "My first Cobre Key",
    "connectivity": {
        "status": "registered",
        "description": ""
    },
    "previous_action": {
        "action_requested": "cancel",
        "action_code": "",
        "action_description": ""
    },
    "created_at": "2025-11-28T21:32:08Z",
    "updated_at": "2025-11-28T21:46:40Z"
}

Modified at 2026-08-25 15:47:16

Obtain one Key

Block or Reactivate Keys