Revokes a key

https://control.ably.net/v1/apps/{app_id}/keys/{key_id}/revoke

Revokes the API key with the specified ID, with the Application ID. This deletes the key.

Access Token Required: API Key

Path Parameters

app_idstringrequired

The application ID.

key_idstringrequired

The key ID.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request POST \
     --url 'https://control.ably.net/v1/apps/{app_id}/keys/{key_id}/revoke' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

POST