Skip to main content
POST
/
v1
/
apis.deleteKeys
Delete API keys
curl --request POST \
  --url https://api.unkey.dev/v1/apis.deleteKeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiId": "api_1234",
  "permanent": false
}
'
{
  "deletedKeys": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
apiId
string
required

The id of the api, that the keys belong to.

Minimum string length: 1
Example:

"api_1234"

​
permanent
boolean
default:false

Delete the keys permanently, if false the keys will be marked as deleted but not removed from the database. In either case, the keys will no longer be valid when verifying them.

Response

The keys have been deleted

​
deletedKeys
integer
required

The number of keys that were deleted