# 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 integrate with ChirpStack without using gRPC directly. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1013/chirpstack-rest-api

## Description

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.

## Links

- Official website: https://www.chirpstack.io/
- Docker Hub: https://hub.docker.com/r/chirpstack/chirpstack-rest-api
- Unraid: https://ca.unraid.net/apps/chirpstack-rest-api-0hgnpqt0v2o73t?q=chirpstack-rest-api

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/1013/chirpstack-rest-api), the self-hosted and open-source app directory.