Skip to content

Revoke an API key

DELETE
/v1/api-keys/{keyId}
curl --request DELETE \
--url https://api.segmentationapi.com/v1/api-keys/example \
--header 'Authorization: Bearer <token>'
keyId
required
string

Revoked key

Media typeapplication/json
object
apiKey
required
object
keyId
required
string
label
required
string
prefix
required
string
revoked
required
boolean
revokedAt
string
nullable
createdAt
required
string
updatedAt
required
string
Examplegenerated
{
"apiKey": {
"keyId": "example",
"label": "example",
"prefix": "example",
"revoked": true,
"revokedAt": "example",
"createdAt": "example",
"updatedAt": "example"
}
}

Authentication is missing, invalid, or expired

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
"error": "example",
"message": "example",
"remainingTokens": 1,
"requestedTokens": 1,
"expiresAt": "2026-04-15T12:00:00Z",
"activeJobId": "example",
"upgradeUrl": "https://example.com",
"retryAfterSeconds": 1
}