Revoke an API key

DELETE

/api-keys/{id}

const url = 'https://example.com/api-keys/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f';
const options = {
  method: 'DELETE',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api-keys/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --cookie bottle.session_token=<bottle.session_token>

Takes effect on the next request made with it. The row is kept for the record.

Authorizations

sessionCookie
keys:write
apiKey
keys:write

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

204

Revoked

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not allowed to manage keys, or asking for a key to do it

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

No such key in this business

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}