{"id":21161324,"url":"https://github.com/apinf/emq-rest-api","last_synced_at":"2025-10-30T15:20:47.416Z","repository":{"id":67914392,"uuid":"81312087","full_name":"apinf/emq-rest-api","owner":"apinf","description":"A REST API for EMQ user and ACL rule management, built with Sails.js","archived":false,"fork":false,"pushed_at":"2017-05-20T23:19:53.000Z","size":143,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-01-21T09:28:02.254Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/apinf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2017-02-08T09:31:06.000Z","updated_at":"2019-10-16T18:57:45.000Z","dependencies_parsed_at":"2023-02-22T22:45:49.553Z","dependency_job_id":null,"html_url":"https://github.com/apinf/emq-rest-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apinf%2Femq-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apinf%2Femq-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apinf%2Femq-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apinf%2Femq-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apinf","download_url":"https://codeload.github.com/apinf/emq-rest-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243606954,"owners_count":20318314,"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-20T13:12:54.519Z","updated_at":"2025-10-22T10:57:03.924Z","avatar_url":"https://github.com/apinf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EMQ API (Sails)\n\nA REST API for managing EMQ Users and ACL Rules, built with [Sails.js](http://sailsjs.org) (for multiple database support)\n\n# Endpoints\n\nSupported all default [blueprints](http://sailsjs.com/documentation/reference/blueprint-api)\n\n### EMQ-USER\n\n- `POST` - `/emq-user`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n  - DATA\n    - emq-user `username`\n    - emq-user `password`\n    - is_superuser\n- `GET (all)` - `/emq-user`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n- `GET (one)` -  `/emq-user/:\u003cid\u003e`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n- `DELETE (one)` - `/emq-user/:\u003cid\u003e`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n- `PUT (one)` - `/emq-user/:\u003cid\u003e`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n  - DATA\n    - emq-user `username`\n    - emq-user `password`\n    - is_superuser\n\n- ... and other that are less common and basically not used\n\n### EMQ_ACL\n\n- `POST` - `/emq-acl`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n  - DATA\n    - `allow` - integer\n    - `ipaddr` - string\n    - `username` - string\n    - `clientid` - string\n    - `access` - integer\n    - `topic` - string\n- `GET (all)` - `/emq-acl`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n- `GET (one)` - `/emq-acl/:\u003cid\u003e`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n- `DELETE (one)` - `/emq-acl/:\u003cid\u003e`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n- `PUT (one)` - `/emq-acl/:\u003cid\u003e`\n  - AUTH (Basic)\n    - admin `username`\n    - admin `password`\n  - DATA\n    - `allow` - integer\n    - `ipaddr` - string\n    - `username` - string\n    - `clientid` - string\n    - `access` - integer\n    - `topic` - string\n\n# Development\nTo set up a local development environment, make sure you have Sails installed globally (`npm install -g sailsjs`). Then:\n\n1. Clone this repository\n2. Open the repository directory in your terminal\n3. Update PostgreSQL credentials in `config/connections.js`\n4. Run the following command, which creates an admin user:\n\n```\nsails_permissions__adminUsername=\"admin\" sails_permissions__adminPassword=\"test12345\" sails lift\n```\n\nOnce Sails has lifted, you can make requests to the REST API.\n\nBe sure to include your Base 64 encoded username and password in the request header:\n\n```\nAuthorization: Basic \u003cBase64enc username:password\u003e\n```\n\nE.g. with curl:\n\n```\ncurl -H \"Authorization: Basic YWRtaW46dGVzdDEyMzQ1\" -X POST \"http://localhost:1337/emq-user\" -d \"username=friendly\u0026password=secretpassword\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapinf%2Femq-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapinf%2Femq-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapinf%2Femq-rest-api/lists"}