← Directory

ChirpStack REST API

ChirpStack REST API is a proxy that exposes the ChirpStack v4 gRPC API as Representational State Transfer (REST) endpoints, letting clients and scripts…

  • Development
  • Home Automation
  • Other
  • Tools & Utilities
ChirpStack REST API is a proxy that exposes the ChirpStack v4 gRPC API as Representational State Transfer (REST) endpoints, letting clients and scripts integrate with ChirpStack without using gRPC directly.

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score

Not enough data yet for a health score. It needs at least 2 of 4 factors: maintenance, popularity, ease of install, resource needs.

Availability: platform listings confirmed today, links checked 12 days ago

No GitHub repository data collected yet.

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 17 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Start ChirpStack in the background Run `docker compose up -d` in the ChirpStack folder; the -d flag means run in the background. This starts the group of related services, so without it the web UI and REST API will not be available. source
  • Open the web UI on port 8080 After the services start, open http://localhost:8080 to log in and begin first-run setup. If you use the wrong port or connect too early, you may see a connection error instead of the login page. source
  • Make an API token for REST calls Log in through the web UI, generate an API token, and include it in your REST (web API) requests. The API help/Swagger page is at http://localhost:8090, and requests without the token will be rejected. source

Fetched 17 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Why is a separate REST API proxy needed after moving to ChirpStack v4?

ChirpStack v4 no longer includes the built-in REST API interface. That interface historically translated REST requests to gRPC so the web interface could work in the browser.

Which port should I use for the REST API help page?

The API help/Swagger page is available on port 8090.

Why are the web UI and REST API unavailable when starting ChirpStack?

Run docker compose up -d to start the group of related services in the background. Without that, the web UI and REST API will not be available.

Answers sourced from context7.com, www.chirpstack.io

Community

Collected 16 days ago - public community threads