Skip to main content
PATCH
/
public
/
api-keys
/
{prefix}
/
revoke
Revoke API key
curl --request PATCH \
  --url https://api.pcxpay.com/v1/public/api-keys/{prefix}/revoke \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "message": "Operation completed successfully",
  "data": {
    "api_key_id": "<string>",
    "prefix": "pcx_abc123",
    "name": "Production Integration",
    "org_id": "<string>",
    "user_id": "<string>",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key issued by PCX. Pass the full key string in the X-API-Key request header. The key encodes your organisation and user identity and is verified on every request.

Path Parameters

​
prefix
string
required

Key prefix (first segment of the API key string)

Response

API key revoked

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string
Example:

"Operation completed successfully"

​
data
object