Skip to content

Remove REST API section of FAQs #2851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove REST API section of FAQs #2851

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c0d2a9
Should I use the REST API directly?
franrob-projects Sep 24, 2025
f240b7f
Tidy up commit
franrob-projects Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/pages/docs/basics/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The realtime interface is implemented using an Ably-defined protocol, primarily

### REST HTTP API <a id="rest-api"/>

Interacting with the [REST HTTP API](/docs/api/rest-api) directly is fully supported. However, Ably recommends using the REST interface of an SDK where possible, as they provide additional features that improve performance and resilience that the REST HTTP API can't deliver on its own. This includes automatic re-routing around network problems by using alternative data centers.
Interacting with the [REST HTTP API](/docs/api/rest-api) directly is fully supported. However, Ably recommends using the REST interface of an SDK where possible, as they provide additional features that improve performance and resilience that the REST HTTP API can't deliver on its own.

## Supported protocols <a id="protocol-adapters"/>

Expand All @@ -88,7 +88,7 @@ The following other protocols are supported:

| Protocol | Description |
|----------|-------------|
| **[MQTT](/docs/protocols/mqtt)** | Translate between the [Message Queuing Telemetry Transport (MQTT)](https://mqtt.org) and Ably's own protocol. Often used in remote devices with small footprints |
| **[SSE](/docs/protocols/sse)** | Use Server Sent Events (SSE) to get a realtime stream of events from Ably, where using a full SDK is impractical. Often used when you have stringent memory restrictions and only need to subscribe to events, not publish them |
| **[Pusher Adapter](/docs/protocols/pusher)** | Quickly migrate from Pusher to Ably using the Pusher Adapter |
| **[PubNub Adapter](/docs/protocols/pubnub)** | Quickly migrate from PubNub to Ably using the PubNub Adapter |
| [MQTT](/docs/protocols/mqtt) | Translate between the [Message Queuing Telemetry Transport (MQTT)](https://mqtt.org) and Ably's own protocol. Often used in remote devices with small footprints |
| [SSE](/docs/protocols/sse) | Use Server Sent Events (SSE) to get a realtime stream of events from Ably, where using a full SDK is impractical. Often used when you have stringent memory restrictions and only need to subscribe to events, not publish them |
| [Pusher Adapter](/docs/protocols/pusher) | Quickly migrate from Pusher to Ably using the Pusher Adapter |
| [PubNub Adapter](/docs/protocols/pubnub) | Quickly migrate from PubNub to Ably using the PubNub Adapter |