BYbymason
deployments-api

Create a deployment

Creates a new deployment.

post/v1/default/deployments

Request

  • Base URL
    https://api.bymason.com
  • Auth
    API key in header Authorization

Request body

groupIdstring required

The unique id for the deployment group receiving the deployment.

namestring required

The name of the artifact being deployed.

versionstring required

The version of the artifact being deployed.

type'ota' | 'config' | 'apk' required
pushboolean

If true, all devices in your deployment group will be notified of an update. Once the device is notified, it will apply the update. If false, the device will apply the update over the next 24 hours.

deployInsecureboolean

If true, the device will download the deployment over http. If false, the device will download the deployment over https.

Response

Create deployment response

idstring uuid

Unique identifier for the deployment

createdAtstring date-time

Timestamp for when the deployment was created

updatedAtstring date-time

Timestamp for when the deployment was created

groupIdstring uuid

The group id the deployment belongs to

deployInsecureboolean

Set to true for devices to download the update over http

isActiveboolean

Whether the deployment is active or not

Changes

No recorded changes to this operation across all 1 revision of this API.