Delete Key

Edit online

Deletes the key and all wallets that use this key. After deletion, the key and associated wallets are no longer usable and are no longer counted in your organization’s wallet total.

HTTP request

DELETE /keys/{keyId}

Authorization requirements

Header	Type	Required	Description
`Authorization`	string	Yes	Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
`X-DFNS-USERACTION`	string	Yes	User action signature used to authorize change-inducing requests. See User Action Signing flows for instructions on generating this signature.

Path parameter

Parameter	Type	Required	Description
keyId	string	Yes	ID of the key to delete. Minimum length: 1.

Request body

curl --request DELETE \
  --url https://api.digitalassets.ibm.com/keys/{keyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-DFNS-USERACTION: <api-key>'

Response

200: Success

Example response:

{
  "id": "key-01snl-t56gb-j8tsok0vn802p80i",
  "scheme": "ECDSA",
  "curve": "ed25519",
  "publicKey": "<string>",
  "status": "Active",
  "custodial": true,
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "masterKey": true,
  "derivedFrom": {
    "keyId": "key-01snl-t56gb-j8tsok0vn802p80i",
    "path": "<string>"
  },
  "name": "<string>",
  "imported": true,
  "exported": true,
  "dateExported": "2023-04-14T20:41:28.715Z",
  "dateDeleted": "2023-04-14T20:41:28.715Z"
}