Revoke an API key

DELETE

/v1/api-keys/{id}

Takes effect at once on this instance and within 30 seconds everywhere.

Authorizations

• session

Parameters

Path Parameters

id

required

string

>= 1 characters <= 128 characters

Responses

200

The key is revoked

object

id

required

string

revoked_at

required

string | null

400

The request is not valid

object

error

required

object

code

required

string

Example

invalid_request

message

required

string

details

Array

request_id

required

string

Example

req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

401

Not signed in, or the API key is not valid

object

error

required

object

code

required

string

Example

invalid_request

message

required

string

details

Array

request_id

required

string

Example

req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

403

Not allowed for this role or key

object

error

required

object

code

required

string

Example

invalid_request

message

required

string

details

Array

request_id

required

string

Example

req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

404

Not found in your organization

object

error

required

object

code

required

string

Example

invalid_request

message

required

string

details

Array

request_id

required

string

Example

req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W