Authentication is managed using HTTP authentication. Every request must include the Authorization HTTP header. Use your API token as the username, and X (or some otherwise bogus text) as the password (only the API token is used for authenticating API requests)
Token can be generated and revocated from the web interface of the WebServices.
Example using the authentication through curl:
curl -H 'Accept: application/json' -u 653638dc733afce75130303fe6e6010f63768af0:X https://dashboard.munic.io/api/v2/:api_endpoint
curl -H 'Accept: application/json' -H 'Content-type: application/json' -u 653638dc733afce75130303fe6e6010f63768af0:X https://dashboard.munic.io/api/v2/:api_endpoint -d '{JSON data}'
Requests that return multiple items will be paginated to 30 items by default. You can specify further pages with the
pageparameter.
| Resource | Description |
|---|---|
| GET /api/v2/configurations | List of existing configurations |
| GET /api/v2/configurations/:id | Show details for a specific configuration |
| POST /api/v2/configurations | Create a new configuration |
| PUT /api/v2/configurations/:id | Update existing configuration |
| GET /api/v2/configurations/:id/assets | List all assets linked to a specific configuration |
| GET /api/v2/configurations/:id/compatible_assets | List all assets compatible with a specific configuration |
| Resource | Description |
|---|---|
| GET /api/v2/assets | List of visible assets |
| GET /api/v2/assets/:imei | Get a specific asset |
| GET /api/v2/assets/:imei/current_configuration | Get the current configuration |
| GET /api/v2/assets/:imei/applied_configuration | Get the applied configuration |
| PUT /api/v2/assets/:imei/force_default_configuration | Force default configuration application on the device |
| PUT /api/v2/assets/:imei/restore_configuration | Force all current configurations reapplication on the device |
| Resource | Description |
|---|---|
| GET /api/v2/assets_groups | List of existing asset groups |
| GET /api/v2/assets_groups/:id | Show details for a specific asset group |
| POST /api/v2/assets_groups | Create a new asset group |
| PUT /api/v2/assets_groups/:id | Update existing configuration |
| PUT /api/v2/assets_groups/:id/add_asset | Update existing configuration by adding an asset to the group |
| PUT /api/v2/assets_groups/:id/remove_asset | Update existing configuration by removing an asset to the group |
| Resource | Description |
|---|---|
| GET /api/v2/campaigns | List of visible campaigns |
| GET /api/v2/campaigns/:id | Get a specific campaign |
| POST /api/v2/campaigns | Create a campaign |
| PUT /api/v2/campaigns/:id/edit | Edit a campaign |
| PUT /api/v2/campaigns/:id/launch | Launch a campaign |
| Resource | Description |
|---|---|
| GET /api/v2/services/remote_files | List all visible files |
| GET /api/v2/services/remote_files/allowed_namespaces | List of all available namespace |
| GET /api/v2/services/remote_files/:id | Request detail for a specific file |
| POST /api/v2/services/remote_files | Push a new file on the server |
| PUT /api/v2/services/remote_files/:id/update_allowed_assets | allowed specific assets for a file |
| PUT /api/v2/services/remote_files/:id/remove_allowed_assets | remove access for a specific file for a list of assets |
| DELETE /api/v2/services/remote_files/:id |
| Resource | Description |
|---|---|
| GET /api/v2/os/available_updates | List of available update for all your visible assets |
| GET /api/v2/os/versions | List of available os versions |
| GET /api/v2/os/versions/:id | Show details for a specific os version |
| GET /api/v2/modules/versions | List of available module versions |
| GET /api/v2/modules/versions/:id | Show details for a specific module version |
| POST /api/v2/modules/versions/:id/messages | Post a message using specific Module Version (Same as -Use App- on web interface) |
| GET /api/v2/modules/versions/:id/my_files | List all file using specific Module Version (Same as -Use App- on web interface) |
| POST /api/v2/modules/versions/:id/remote_file | Post a file using specific Module Version (Same as -Use App- on web interface) |