Sign in

v1

latestOpenAPI 3.0.12026-07-142257126.4 KB
keys

Updates a key

Update the API key with the specified key ID, for the application with the specified application ID.

patch/apps/{app_id}/keys/{key_id}

Path parameters

app_idstring required

The application ID.

key_idstring required

The API key ID.

Request body

capabilitiesstring[]

The capabilities that this key has. More information on capabilities can be found in the <a href="https://ably.com/documentation/core-features/authentication#capabilities-explained">Ably documentation</a>.

channelsstring

Specify the channels and queues that this key can be used with.

namestring

The name for your API key. This is a friendly name for your reference.

Response

Key updated

appIdstring

The Ably application ID which this key is associated with.

capabilityobject

The capabilities that this key has. More information on capabilities can be found in the <a href="https://ably.com/documentation/core-features/authentication#capabilities-explained">Ably documentation</a>.

createdinteger

Unix timestamp representing the date and time of creation of the key.

idstring

The key ID.

keystring

The complete API key including API secret.

modifiedinteger

Unix timestamp representing the date and time of the last modification of the key.

namestring

The name of the application this key is associated with.

Example response

{
  "appId": "28GY6a",
  "created": 1602844091815,
  "modified": 1614679682091
}