ChirpStack gRPC to REST API proxy
The ChirpStack gRPC to REST API proxy exposes the ChirpStack (v4) gRPC as REST API. While the gRPC API interface exposed by ChirpStack (v4) is recommended, in some use-cases a REST API cna be more convenient. It could also help when migrating from ChirpStack v3 to v4 as previously this proxy was embedded inside the ChirpStack Application Server.
chirpstack-rest-api --server localhost:8080 --bind 0.0.0.0:8090 --insecure
--serverpoints to the ChirpStack gRPC endpoint. If ChirpStack is installed on the same machine and uses port
8080(default), you can use the default value. You can also use the environment variable
--binddefines to which interface and port the REST API server will bind. In the above example (and default value), the REST API server will be exposed on port
8090. YOu can also use the environment variable
--insecureindicates that the gRPC interface is not secured using a TLS certificate. You can also use the environment variable
INSECURE(setting this to any value enables insecure mode, e.g. do not use
Building from source
To start the Docker Compose based development environment:
Within this development shell, you can use one of the following commands
(see also the included
# Compile binary
# Create distributable archives and packages.
# Create snapshot archives and packages.
# Re-generate API definitions (VERSION must be set to the ChirpStack version)
VERSION=v4.0.0 make generate
ChirpStack REST API is distributed under the MIT license. See also LICENSE.