You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/account/app/index.textile
+1-1
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ Create, manage, and configure "API keys":/account/dashboard/api by setting capab
54
54
55
55
h3. Integrations
56
56
57
-
"Integrate":/general/integrations Ably with external services, enabling data to flow between Ably channels and third-party platforms:
57
+
"Integrate":/docs/general/integrations Ably with external services, enabling data to flow between Ably channels and third-party platforms:
58
58
59
59
* Ably events can trigger webhook requests to external services, or external services can send data to Ably using incoming webhooks.
60
60
* Ably enables continuous streaming of events to external services like Amazon Kinesis or Kafka, or can receive inbound streams from external services.
Ably queues provide a way to consume realtime data using the "AMQP":/general/queues#consume-amqp or "STOMP":/general/queues#consume-stomp protocols. Find out more about using "Ably queues":/general/queues#what.
7
+
Ably queues provide a way to consume realtime data using the "AMQP":/docs/general/queues#consume-amqp or "STOMP":/docs/general/queues#consume-stomp protocols. Find out more about using "Ably queues":/docs/general/queues#what.
8
8
9
9
h2. Manage your Ably queues
10
10
@@ -26,6 +26,6 @@ When provisioning a new queue, you'll need to specify several things:
26
26
27
27
h3(#setup). Set up queue rules
28
28
29
-
Once you have provisioned a physical queue, you need to set up one or more queue rules to republish messages, presence events or channel events from pub/sub channels into a queue. Queue rules can either be used to publish to internal queues (hosted by Ably) or external external streams or queues (such as Amazon Kinesis and RabbitMQ). Publishing to external streams or queues is part of our "Ably Firehose servers":/general/firehose.
29
+
Once you have provisioned a physical queue, you need to set up one or more queue rules to republish messages, presence events or channel events from pub/sub channels into a queue. Queue rules can either be used to publish to internal queues (hosted by Ably) or external external streams or queues (such as Amazon Kinesis and RabbitMQ). Publishing to external streams or queues is part of our "Ably Firehose servers":/docs/general/firehose.
30
30
31
-
Ably queue rules are setup in the *Integrations* tab found within your app *dashboard*. Find out more about setting up "queue rules":/general/queues#setup.
31
+
Ably queue rules are setup in the *Integrations* tab found within your app *dashboard*. Find out more about setting up "queue rules":/docs/general/queues#setup.
Ably Control API is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure. Details of the API can be found in the "Control API Reference":/api/control-api.
11
+
Ably Control API is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure. Details of the API can be found in the "Control API Reference":/docs/api/control-api.
12
12
13
13
Using the Control API you can automate the provisioning, management, and testing of your Ably realtime infrastructure. You can dynamically create Ably apps, configure them, and delete them if necessary. You can implement multi-tenancy solutions for your customers, and create configuration-driven environments that can easily be replicated under programmatic control. Once these environments are created you can also test them using Control API.
14
14
@@ -18,8 +18,8 @@ With the Control API you can create and manage:
18
18
* API keys for an Ably app
19
19
* "Account and app statistics":/metadata-stats/stats
Repetitive operations such as creating, updating or deleting Ably apps, enumerating queues, creation of rules, and other tasks that would be time-consuming to carry out manually, can be automated using the Control API.
25
25
@@ -29,7 +29,7 @@ The following diagram illustrates an example use case:
29
29
<img src="@content/screenshots/control-api/provision-and-test.png" style="width: 100%" alt="Provision and Test">
30
30
</a>
31
31
32
-
In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/api/realtime-sdk or "REST API":/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
32
+
In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/docs/api/realtime-sdk or "REST API":/docs/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
33
33
34
34
In order to use the Control API you must first create an access token in the "Ably dashboard":https://ably.com/accounts/any. You can then use the Control API to manage many account functions without having to interact with the dashboard.
35
35
@@ -123,7 +123,7 @@ Sample response:
123
123
124
124
h2(#ids). Account ID and app ID
125
125
126
-
Operations that affect your entire account, such as "listing the apps":/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
126
+
Operations that affect your entire account, such as "listing the apps":/docs/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/docs/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
127
127
128
128
h3(#account-id). How to find your account ID
129
129
@@ -178,7 +178,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
178
178
}'
179
179
```
180
180
181
-
See the "API reference":/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
181
+
See the "API reference":/docs/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
182
182
183
183
Sample response, with @entries@ trimmed for readability:
184
184
@@ -243,7 +243,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
243
243
}'
244
244
```
245
245
246
-
See the "API reference":/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
246
+
See the "API reference":/docs/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
247
247
248
248
Sample response:
249
249
@@ -302,7 +302,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/stats
302
302
}'
303
303
```
304
304
305
-
See the "API reference":/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
305
+
See the "API reference":/docs/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
306
306
307
307
Sample response, with @entries@ trimmed for readability:
308
308
@@ -325,7 +325,7 @@ Sample response, with @entries@ trimmed for readability:
325
325
326
326
h3(#examples-queues). Queues
327
327
328
-
You can use the Control API to manage "Ably queues":/general/queues. The main operations are:
328
+
You can use the Control API to manage "Ably queues":/docs/general/queues. The main operations are:
329
329
330
330
* List all Ably queues
331
331
* Create a queue
@@ -394,7 +394,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/queue
394
394
}'
395
395
```
396
396
397
-
See the "API reference":/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
397
+
See the "API reference":/docs/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
398
398
399
399
Sample response:
400
400
@@ -577,7 +577,7 @@ In this case there is only a status code returned (200), or an error code.
577
577
578
578
h3(#examples-rules). Rules
579
579
580
-
You can use the Control API to manage Ably "integration rules":/general/integrations. The main operations are:
580
+
You can use the Control API to manage Ably "integration rules":/docs/general/integrations. The main operations are:
581
581
582
582
* List all rules for an app
583
583
* List details of a specific rule using rule ID
@@ -642,7 +642,7 @@ The rule details are returned for the specified rule.
642
642
643
643
h4(#examples-rules-create). Create a rule
644
644
645
-
The following example creates a rule with the following "configuration":/general/webhooks#configure:
645
+
The following example creates a rule with the following "configuration":/docs/general/webhooks#configure:
646
646
647
647
|_. Parameter |_. Value |_. Description |
648
648
| @ruleType@ | http | The type of rule, in this case a webhook rule |
@@ -653,7 +653,7 @@ The following example creates a rule with the following "configuration":/general
653
653
| @format@ | json | Format of encoding for the rule, in this case JSON |
654
654
| @name@ | User-Agent | Optional header or headers, including custom headers that might be required. In this case a user agent header is specified (this needs to be set for some providers) |
655
655
| @value@ | user-agent-name | The value of the header |
656
-
| @enveloped@ | true | Wrap packet in "metadata":/general/webhooks#envelope |
656
+
| @enveloped@ | true | Wrap packet in "metadata":/docs/general/webhooks#envelope |
657
657
658
658
The corresponding request is:
659
659
@@ -827,4 +827,4 @@ Now that you have obtained the token and IDs, you can learn how to send a reques
You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/api/control-api for further information.
830
+
You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/docs/api/control-api for further information.
Depending on availability, an Ably client library SDK may support both a realtime interface and a REST interface. Some SDKs only provide a REST interface. You can check availability on the "SDK page":https://ably.com/download.
29
29
30
-
The "realtime interface":/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
30
+
The "realtime interface":/docs/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/docs/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
31
31
32
32
Typically the REST interface is used on the server, as the server's main task is to authenticate clients, but does not usually need to subscribe to a channel to obtain realtime events.
33
33
@@ -47,15 +47,15 @@ The SDKs that have API references generated from source code are:
47
47
48
48
h2(#rest-api). REST API
49
49
50
-
A raw "REST API":/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
50
+
A raw "REST API":/docs/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
51
51
52
52
h2(#sse-api). SSE API
53
53
54
-
The "Ably Server-Sent Events API":/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
54
+
The "Ably Server-Sent Events API":/docs/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
55
55
56
56
h2(#control-api). Control API
57
57
58
-
"Ably Control API":/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
58
+
"Ably Control API":/docs/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
0 commit comments