Ably Control

Ably Control integration (Developer Tools). Imported from open-connector.

API key14 toolshttps://control.ably.net/v1

GET

ably_control_get_current_account

Retrieve the Ably Control API token, user, and account associated with the access token.

/me

GET

ably_control_get_account_stats

Retrieve account-level Ably statistics for the connected account or account ID.

/accounts/{accountId}/stats

7 parameters

Param	Type	Required	Description
accountId	string	required	The Ably account ID.
appId	string	optional	The Ably application ID.
start	integer	optional	A Unix timestamp in milliseconds.
end	integer	optional	A Unix timestamp in milliseconds.
limit	integer	optional	The maximum number of statistics records to return.
unit	string	optional	The statistics aggregation unit.
direction	string	optional	The pagination direction.

GET

ably_control_get_app_stats

Retrieve app-level Ably statistics for an Ably app.

/apps/{appId}/stats

7 parameters

Param	Type	Required	Description
accountId	string	optional	The Ably account ID.
appId	string	required	The Ably application ID.
start	integer	optional	A Unix timestamp in milliseconds.
end	integer	optional	A Unix timestamp in milliseconds.
limit	integer	optional	The maximum number of statistics records to return.
unit	string	optional	The statistics aggregation unit.
direction	string	optional	The pagination direction.

GET

ably_control_list_apps

List Ably apps in the connected account or supplied account ID.

/accounts/{accountId}/apps

1 parameter

Param	Type	Required	Description
accountId	string	required	The Ably account ID.

POST

ably_control_create_app

Create an Ably app in the connected account or supplied account ID.

/accounts/{accountId}/apps

10 parameters

Param	Type	Required	Description
accountId	string	required	The Ably account ID.
name	string	required	The app name.
status	string	optional	The app status.
tlsOnly	boolean	optional	Whether to enforce TLS for all connections.
fcmKey	string	optional	—
fcmServiceAccount	string	optional	—
fcmProjectId	string	optional	—
apnsCertificate	string	optional	—
apnsPrivateKey	string	optional	—
apnsUseSandboxEndpoint	boolean	optional	—

PATCH

ably_control_update_app

Update editable settings for an Ably app.

/apps/{appId}

10 parameters

Param	Type	Required	Description
appId	string	required	The Ably application ID.
name	string	optional	The app name.
status	string	optional	The app status.
tlsOnly	boolean	optional	Whether to enforce TLS for all connections.
fcmKey	string	optional	—
fcmServiceAccount	string	optional	—
fcmProjectId	string	optional	—
apnsCertificate	string	optional	—
apnsPrivateKey	string	optional	—
apnsUseSandboxEndpoint	boolean	optional	—

DELETE

ably_control_delete_app

Delete an Ably app by app ID.

/apps/{appId}

1 parameter

Param	Type	Required	Description
appId	string	required	The Ably application ID.

GET

ably_control_list_keys

List API keys for an Ably app.

/apps/{appId}/keys

1 parameter

Param	Type	Required	Description
appId	string	required	The Ably application ID.

POST

ably_control_create_key

Create an API key for an Ably app.

/apps/{appId}/keys

3 parameters

Param	Type	Required	Description
appId	string	required	The Ably application ID.
name	string	required	The key name.
capability	object	required	Ably channel capabilities keyed by channel or resource name.

PATCH

ably_control_update_key

Update an Ably API key name or capability.

/apps/{appId}/keys/{keyId}

4 parameters

Param	Type	Required	Description
appId	string	required	The Ably application ID.
keyId	string	required	The Ably API key ID.
name	string	optional	The key name.
capability	object	optional	Ably channel capabilities keyed by channel or resource name.

POST

ably_control_revoke_key

Revoke an Ably API key by key ID.

/apps/{appId}/keys/{keyId}/revoke

2 parameters

Param	Type	Required	Description
appId	string	required	The Ably application ID.
keyId	string	required	The Ably API key ID.

GET

ably_control_list_queues

List queues for an Ably app.

/apps/{appId}/queues

1 parameter

Param	Type	Required	Description
appId	string	required	The Ably application ID.

POST

ably_control_create_queue

Create a queue for an Ably app.

/apps/{appId}/queues

5 parameters

Param	Type	Required	Description
appId	string	required	The Ably application ID.
name	string	required	The queue name.
region	string	required	The queue region, such as eu-west-1-a.
ttl	integer	optional	The message TTL in seconds.
maxLength	integer	optional	The maximum queue length.

DELETE

ably_control_delete_queue

Delete an Ably queue by queue ID.

/apps/{appId}/queues/{queueId}

2 parameters

Param	Type	Required	Description
appId	string	required	The Ably application ID.
queueId	string	required	The Ably queue ID.