waku-org/nwaku
1
0
Fork 0
mirror of https://github.com/waku-org/nwaku.git synced 2025-01-15 01:14:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
nwaku/docs/operators/how-to/configure-rest-api.md
Ivansete-status b2acb54d6a
feat(rest-api-store): new rest api to retrieve store waku messages (#1611) (#1630) 
* feat: new rest api based on the current store json-rpc api and
following the same structure as the current relay rest api.

* feat: the store api attend GET requests to retrieve historical messages

* feat: unit tests.

* feat: allow return message to rest-client in case error (4XX or 5XX)

* chore: always allow to call the store api endpoints (only rest) without explicit storenode (#1575)

* feat: always mounting the current node as storenode client
2023-04-06 11:43:19 +02:00

835 B
Raw Blame History

Configure a REST API node

A subset of the node configuration can be used to modify the behaviour of the HTTP REST API.

These are the relevant command line options:

CLI option Description Default value
--rest Enable Waku REST HTTP server. false
--rest-address Listening address of the REST HTTP server. 127.0.0.1
--rest-port Listening port of the REST HTTP server. 8645
--rest-relay-cache-capacity Capacity of the Relay REST API message cache. 30
--rest-admin Enable access to REST HTTP Admin API. false
--rest-private Enable access to REST HTTP Private API. false

Note that these command line options have their counterpart option in the node configuration file.

Example:

wakunode2 --rest=true