Skip to main content
POST
/
v1
/
api-keys
/
{id}
/
revoke
Revoke an API key
curl --request POST \
  --url http://localhost:8080/v1/api-keys/{id}/revoke \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "merchant_id": "<string>",
  "name": "<string>",
  "prefix": "ak_live_",
  "environment": "test",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

id
string
required

Resource identifier (xid format)

Response

200 - application/json

API key revoked

id
string
merchant_id
string
name
string
prefix
string
Example:

"ak_live_"

environment
enum<string>
Available options:
test,
live
expires_at
string<date-time>
last_used_at
string<date-time>
revoked_at
string<date-time>
created_at
string<date-time>