Control API v1
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 22
apps
- GETLists apps
/accounts/:account_id/appsList all applications for the specified account ID. - POSTCreates an app
/accounts/:account_id/appsCreates an application with the specified properties. - DELETEDeletes an app
/apps/:idDeletes the application with the specified application ID. - PATCHUpdates an app
/apps/:idUpdates the application with the specified application ID. - POSTUpdates app's APNs info from a `.p12` file
/apps/:id/pkcs12Updates the application's Apple Push Notification service (APNs) information.
keys
- GETLists app keys
/apps/:app_id/keysLists the API keys associated with the application ID. - POSTCreates a key
/apps/:app_id/keysCreates an API key for the application specified. - PATCHUpdates a key
/apps/:app_id/keys/:key_idUpdate the API key with the specified key ID, for the application with the specified application ID. - POSTRevokes a key
/apps/:app_id/keys/:key_id/revokeRevokes the API key with the specified ID, with the Application ID. This deletes the key.
namespaces
- GETLists namespaces
/apps/:app_id/namespacesList the namespaces for the specified application ID. - POSTCreates a namespace
/apps/:app_id/namespacesCreates a namespace for the specified application ID. - DELETEDeletes a namespace
/apps/:app_id/namespaces/:namespace_idDeletes the namespace with the specified ID, for the specified application ID. - PATCHUpdates a namespace
/apps/:app_id/namespaces/:namespace_idUpdates the namespace with the specified ID, for the application with the specified application ID.
queues
- GETLists queues
/apps/:app_id/queuesLists the queues associated with the specified application ID. - POSTCreates a queue
/apps/:app_id/queuesCreates a queue for the application specified by application ID. The properties for the queue to be created are specified in the request body. - DELETEDeletes a queue
/apps/:app_id/queues/:queue_idDelete the queue with the specified queue name, from the application with the specified application ID.
rules
- GETLists Reactor rules
/apps/:app_id/rulesLists the rules for the application specified by the application ID. - POSTCreates a Reactor rule
/apps/:app_id/rulesCreates a rule for the application with the specified application ID. - GETGets a reactor rule by rule ID
/apps/:app_id/rules/:rule_idReturns the rule specified by the rule ID, for the application specified by application ID. - DELETEDeletes a Reactor rule
/apps/:app_id/rules/:rule_id - PATCHUpdates a Reactor rule
/apps/:app_id/rules/:rule_id
tokens
- GETGet token details
/me
API details
- Base URL
https://control.ably.net/v1- Authentication
- A bearer token in the Authorization header
- Operations
- 22 operations on 13 pathsGET 7POST 7PATCH 4DELETE 4
- Main resources
- apps 5rules 5keys 4namespaces 4queues 3tokens 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0.14 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Control API v1 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Control API v1 collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists apps” (GET /accounts/:account_id/apps), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Control API v1?
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… It is listed under Developer tools and has 22 endpoints.
Who publishes the Control API v1?
It is listed from Ably's public API description (an OpenAPI document), not published by Ably on Swastik Codes. Anyone who controls ably.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Control API v1?
Requests go to https://control.ably.net/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Control API v1?
With A bearer token in the Authorization header.
How many endpoints does the Control API v1 have?
22 operations on 13 paths (7 GET, 7 POST, 4 PATCH, 4 DELETE). The largest groups are apps, rules, keys, namespaces.
Is forking the Control API v1 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.