Skip to content
This repository was archived by the owner on Feb 26, 2026. It is now read-only.

Commit 26e67aa

Browse files
authored
MG-297 - Add instructions for Readers Ports (#72)
* add instructions for reader Signed-off-by: Musilah <nataleigh.nk@gmail.com> * fix urls Signed-off-by: Musilah <nataleigh.nk@gmail.com> --------- Signed-off-by: Musilah <nataleigh.nk@gmail.com>
1 parent ff9c892 commit 26e67aa

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/dev-guide/api.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2083,16 +2083,16 @@ Connection: keep-alive
20832083
20842084
### Read Messages
20852085
2086-
Reads messages from database for a given channel
2086+
Reads messages from database for a given channel.
20872087
20882088
```bash
2089-
curl -sSiX GET http://localhost:<service_port>/m/<domain_id>/c/<channel_id>?[offset=<offset>]&[limit=<limit>] -H "Authorization: Client <client_secret>"
2089+
curl -sSiX GET http://localhost:<service_port>/<domain_id>/channels/<channel_id>/messages?[offset=<offset>]&[limit=<limit>] -H "Authorization: Bearer <access_token>"
20902090
```
20912091
2092-
For example:
2092+
For example
20932093
20942094
```bash
2095-
curl -sSiX GET http://localhost:9009/m/6a45444c-4c89-46f9-a284-9e731674726a/c/aecf0902-816d-4e38-a5b3-a1ad9a7cf9e8 -H "Authorization: Client a83b9afb-9022-4f9e-ba3d-4354a08c273a"
2095+
curl -sSiX GET http://localhost:9009/6a45444c-4c89-46f9-a284-9e731674726a/channels/aecf0902-816d-4e38-a5b3-a1ad9a7cf9e8/messages -H "Authorization: Client a83b9afb-9022-4f9e-ba3d-4354a08c273a"
20962096
20972097
HTTP/1.1 200 OK
20982098
Content-Type: application/json
@@ -2135,6 +2135,11 @@ Content-Length: 660
21352135
}
21362136
```
21372137
2138+
> **Note**: The `<service_port>` depends on the **active reader service** you're using. The example above uses the **HTTP interface** of the Postgres Reader.
2139+
>
2140+
> - Use `9009` for the **Postgres Reader** (HTTP)
2141+
> - Use `9011` for the **Timescale Reader** (HTTP)
2142+
21382143
## Groups
21392144
21402145
### Create group

0 commit comments

Comments
 (0)