{"@context": "https://schema.org", "@type": "WebAPI", "name": "Control API v1 API", "description": "Use the Control API to manage your applications, namespaces, keys, queues, rules, and more. Detailed information on using this API can be found in the Ably developer documentation. Control API is currently in Beta.", "provider": {"@type": "Organization", "name": "ably.net"}, "documentation": "https://raw.githubusercontent.com/ably/open-specs/main/definitions/control-v1.yaml"}
Index / APIs / ably.net

Control API v1 API

Use the Control API to manage your applications, namespaces, keys, queues, rules, and more. Detailed information on using this API can be found in the Ably developer documentation. Control API is currently in Beta.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://control.ably.net/v1

auth: b e a r

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

Control API v1 v1.0.14

Use the Control API to manage your applications, namespaces, keys, queues, rules, and more. Detailed information on using this API can be found in the Ably developer documentation. Control API is currently in Beta.

methodpathwhat the vendor says it does
GET/accounts/{account_id}/appsLists apps List all applications for the specified account ID. apps
POST/accounts/{account_id}/appsCreates an app Creates an application with the specified properties. apps
GET/apps/{app_id}/keysLists app keys Lists the API keys associated with the application ID. keys
POST/apps/{app_id}/keysCreates a key Creates an API key for the application specified. keys
PATCH/apps/{app_id}/keys/{key_id}Updates a key Update the API key with the specified key ID, for the application with the specified application
POST/apps/{app_id}/keys/{key_id}/revokeRevokes a key Revokes the API key with the specified ID, with the Application ID. This deletes the key. keys
GET/apps/{app_id}/namespacesLists namespaces List the namespaces for the specified application ID. namespaces
POST/apps/{app_id}/namespacesCreates a namespace Creates a namespace for the specified application ID. namespaces
PATCH/apps/{app_id}/namespaces/{namespace_id}Updates a namespace Updates the namespace with the specified ID, for the application with the specified applic
DELETE/apps/{app_id}/namespaces/{namespace_id}Deletes a namespace Deletes the namespace with the specified ID, for the specified application ID. namespaces
GET/apps/{app_id}/queuesLists queues Lists the queues associated with the specified application ID. queues
POST/apps/{app_id}/queuesCreates a queue Creates a queue for the application specified by application ID. The properties for the queue
DELETE/apps/{app_id}/queues/{queue_id}Deletes a queue Delete the queue with the specified queue name, from the application with the specified applic
GET/apps/{app_id}/rulesLists Reactor rules Lists the rules for the application specified by the application ID. rules
POST/apps/{app_id}/rulesCreates a Reactor rule Creates a rule for the application with the specified application ID. rules
GET/apps/{app_id}/rules/{rule_id}Gets a reactor rule by rule ID Returns the rule specified by the rule ID, for the application specified by app
PATCH/apps/{app_id}/rules/{rule_id}Updates a Reactor rule rules
DELETE/apps/{app_id}/rules/{rule_id}Deletes a Reactor rule rules
PATCH/apps/{id}Updates an app Updates the application with the specified application ID. apps
DELETE/apps/{id}Deletes an app Deletes the application with the specified application ID. apps
POST/apps/{id}/pkcs12Updates app's APNs info from a `.p12` file Updates the application's Apple Push Notification service (APNs) in
GET/meGet token details tokens

specification origin: https://raw.githubusercontent.com/ably/open-specs/main/definitions/control-v1.yaml

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.