{"id":21371491,"url":"https://github.com/chirpstack/chirpstack-rest-api","last_synced_at":"2025-07-13T07:31:26.475Z","repository":{"id":44924951,"uuid":"513089215","full_name":"chirpstack/chirpstack-rest-api","owner":"chirpstack","description":"ChirpStack gRPC API to REST proxy.","archived":false,"fork":false,"pushed_at":"2024-11-15T09:38:57.000Z","size":2977,"stargazers_count":17,"open_issues_count":5,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-15T10:35:41.042Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chirpstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"chirpstack"}},"created_at":"2022-07-12T10:00:23.000Z","updated_at":"2024-11-15T09:39:00.000Z","dependencies_parsed_at":"2024-05-15T23:40:59.464Z","dependency_job_id":"93dc1f68-52ea-472a-b0e8-358e408623e5","html_url":"https://github.com/chirpstack/chirpstack-rest-api","commit_stats":{"total_commits":31,"total_committers":4,"mean_commits":7.75,"dds":0.09677419354838712,"last_synced_commit":"8e9cb33a8ba7c6749cd64449983fdb3173b13ad0"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chirpstack","download_url":"https://codeload.github.com/chirpstack/chirpstack-rest-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225862809,"owners_count":17535998,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T08:13:39.600Z","updated_at":"2024-11-22T08:13:40.273Z","avatar_url":"https://github.com/chirpstack.png","language":"Go","readme":"# ChirpStack gRPC to REST API proxy\n\nThe ChirpStack gRPC to REST API proxy exposes the ChirpStack (v4) gRPC as REST\nAPI. While the gRPC API interface exposed by ChirpStack (v4) is recommended,\nin some use-cases a REST API can be more convenient. It could also help when\nmigrating from ChirpStack v3 to v4 as previously this proxy was embedded inside\nthe ChirpStack Application Server.\n\n## Usage\n\n```bash\nchirpstack-rest-api --server localhost:8080 --bind 0.0.0.0:8090 --insecure --cors \"*\"\n```\n\n* `--server` points to the ChirpStack gRPC endpoint. If ChirpStack is installed\n  on the same machine and uses port `8080` (default), you can use the default\n  value. You can also use the environment variable `SERVER`.\n* `--bind` defines to which interface and port the REST API server will bind.\n  In the above example (and default value), the REST API server will be exposed\n  on port `8090`. YOu can also use the environment variable `BIND`.\n* `--insecure` indicates that the gRPC interface is not secured using a TLS\n  certificate. You can also use the environment variable `INSECURE` (setting\n  this to any value enables insecure mode, e.g. do not use `INSECURE=false`!).\n* `--cors` defines the CORS policy by setting the AllowedOrigins Header. You can also use the environment variable `CORS`. `--cors \"*\"` allows all origins. Default is `--cors 0.0.0.0` which disables CORS.\n\n## Debian / Ubuntu\n\n### Add ChirpStack repository\n\nAdd the ChirpStack repository as described in the [Documentation](https://www.chirpstack.io/docs/chirpstack/downloads.html#debian--ubuntu-repository).\n\n### Install package\n\nAfter you have added the ChirpStack repository, you can install this component\nusing the following command:\n\n```bash\nsudo apt install chirpstack-rest-api\n```\n\n### Configuration\n\nEnvironment variables can be used to configure the ChirpStack REST API proxy.\nYou will find this configuration in `/etc/chirpstack-rest-api/environment`.\n\n### (Re)start and stop\n\n```bash\nsudo systemctl [restart|start|stop] chirpstack-rest-api\n```\n\n## Downloads\n\nPlease refer to: [https://artifacts.chirpstack.io/downloads/chirpstack-rest-api/](https://artifacts.chirpstack.io/downloads/chirpstack-rest-api/).\n\n## Building from source\n\nTo start the Docker Compose based development environment:\n\n```\nmake devshell\n```\n\nWithin this development shell, you can use one of the following commands\n(see also the included `Makefile`):\n\n```bash\n# Compile binary\nmake build\n\n# Create distributable archives and packages.\nmake dist\n\n# Create snapshot archives and packages.\nmake snapshot\n\n# Re-generate API definitions (VERSION must be set to the ChirpStack version)\nVERSION=v4.0.0 make generate\n```\n\n## License\n\nChirpStack REST API is distributed under the MIT license. See also\n[LICENSE](https://github.com/chirpstack/chirpstack-rest-api/blob/master/LICENSE).\n","funding_links":["https://github.com/sponsors/chirpstack"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchirpstack%2Fchirpstack-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchirpstack%2Fchirpstack-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchirpstack%2Fchirpstack-rest-api/lists"}