curl -X DELETE "https://developer.encrata.com/api/account/keys?id=a1b2c3d4-0000-4000-8000-000000000000" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
{
"message": "API key revoked"
}
{
"message": "API key deleted"
}
{
"success": false,
"result": { "code": "bad_request" },
"message": "Key ID is required",
"request_id": "req_7f3a9c21",
"error": "Key ID is required"
}
{
"success": false,
"result": { "code": "not_found" },
"message": "API key not found",
"request_id": "req_7f3a9c21",
"error": "API key not found"
}
API Keys
Revoke or Delete API Key
Revoke an API key (soft disable) or permanently delete it.
DELETE
/
api
/
account
/
keys
curl -X DELETE "https://developer.encrata.com/api/account/keys?id=a1b2c3d4-0000-4000-8000-000000000000" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
{
"message": "API key revoked"
}
{
"message": "API key deleted"
}
{
"success": false,
"result": { "code": "bad_request" },
"message": "Key ID is required",
"request_id": "req_7f3a9c21",
"error": "Key ID is required"
}
{
"success": false,
"result": { "code": "not_found" },
"message": "API key not found",
"request_id": "req_7f3a9c21",
"error": "API key not found"
}
Authentication
Requires an API key in theAuthorization header.
Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Request
The key’s database id, as returned by
List API keys. Not the
key_prefix.Set to the exact string
true to permanently delete the key instead of
revoking it. Any other value revokes.Revoke (soft disable)
curl -X DELETE "https://developer.encrata.com/api/account/keys?id=a1b2c3d4-0000-4000-8000-000000000000" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Delete (permanent removal)
curl -X DELETE "https://developer.encrata.com/api/account/keys?id=a1b2c3d4-0000-4000-8000-000000000000&permanent=true" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
{
"message": "API key revoked"
}
{
"message": "API key deleted"
}
Known issue: A revoked key can be enabled again with
PATCH ?action=enable
and revealed with GET /api/account/keys/reveal. Revoked and disabled keys
both appear as is_active: false. Permanently delete a leaked key.Permissions
readonly members get 403. A tech member can only revoke their own keys;
only a workspace admin can revoke another member’s key. A key that is out of
your scope returns 404, the same as an unknown id.
Errors
Errors return the shared envelope withsuccess, result.code, message, and
request_id. A legacy error key is included alongside it.
curl -X DELETE "https://developer.encrata.com/api/account/keys?id=a1b2c3d4-0000-4000-8000-000000000000" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
{
"message": "API key revoked"
}
{
"message": "API key deleted"
}
{
"success": false,
"result": { "code": "bad_request" },
"message": "Key ID is required",
"request_id": "req_7f3a9c21",
"error": "Key ID is required"
}
{
"success": false,
"result": { "code": "not_found" },
"message": "API key not found",
"request_id": "req_7f3a9c21",
"error": "API key not found"
}
Was this page helpful?