Mason Device Console API Docs (v1.0)

This API endpoint enables the creation or update of remote settings bundles. It requires an HTTP POST request with a RemoteSettingsBundle object provided in the request body. The API checks the logged user's permissions, sets the creation date if it's a new bundle, and then saves the remote settings bundle.

This endpoint allows users to refresh a JWT token. It takes the refreshToken, which was received in the getjwttoken API and generates a new jwt token in the request body.

This endpoint allows users to obtain a JWT token (short expiration) and a refresh token (long expiration) for authentication of further API calls. It takes a JSON object containing the username and password (required fields) in the request body. The method performs authentication, generates tokens, and handles various authentication exceptions

This API endpoint allows for the creation and saving of a new command. It takes a Command object as the request body which includes the execution condition as set in the reference trigger and returns the unique identifier (commandID) of the newly created command.

This API endpoint allows for the modification of the state of a command identified by its unique command ID. It initiates a state change based on the provided 'newstate' parameter.

Send a command with provided data to multiple devices. Command could be any supported command such as send message command, install package command, OTA and more. Returns metadata about the sent command.

Creates a new command with provided data and sends it to devices based on a filter. Groups, which are filters filtered by tags, can also be a target for this command. The API returns metadata about the sent command.

This API retrieves a list of commands based on the provided filters. It supports pagination and filtering by action, search string, search type, search column, and more.

Retrieves a command by its ID with additional metadata and returns a response containing the command and filter information if applicable

This API retrieves statistics for a specific command based on its ID.

This API retrieves command results for a specific command. It supports pagination and filtering by search string, sort column, sort order, and status filter.

This endpoint allows the retrieval of live data from a specific device identified by its device ID. Device authentication is required. Upon receiving the request, the API triggers the retrieval of live data from the device through a background task. The live data is collected and stored in a container associated with the device session. The API returns the live data response, containing telemetry information and other relevant device data. The API has a rate limit of 1 API call for each user and device every 1 minute.

This endpoint retrieves installed app data for a specified group. The method requires authentication and a JSON payload containing package names and group information. The response contains summarized app data for the group along with metadata indicating the success of the operation

Access detailed information about a device with this API endpoint. It provides a more comprehensive view of the device's status, usage, and configuration compared to the dashboard data.

Use this API endpoint to retrieve a paginated list of all available devices. You can specify pagination, sorting, and filtering parameters to customize the result. The response is provided as a DeviceListResponse containing device information

This API endpoint is used to create or update a repository item. It expects an HTTP POST request with a RepositoryItemBase object in the request body. The API performs access control checks, executes pre-save operations, and then saves the repository item. If it's a new item, it sets the creation date before saving.

This endpoint retrieves all repository items. It first checks the access control list (ACL) to ensure that the logged-in user has the necessary permissions abd then returns the list of all repository items.

This API endpoint handles the saving of file data, including associated metadata. It requires an HTTP POST request with a RepositoryFileMetaData object provided in the request body. The API verifies the logged user's permissions, processes the file data, and then saves it. Once the file or package has been successfully stored, it can be sent to the device(s).