Skip to main content

Create a new OTA Deployment

POST 
/deployments/create

Creates a new OTA deployment. Any asset in deployable state can be used for deployment.

Request​

Body

    deploymentName string
    deploymentComment string
    deploymentStart integerrequired

    Specify unix timestamp(UTC) at which deployment will start. You schedule a deployment to become active at any prespecified time.

    deploymentExpiry integer

    Specify when deployment should stop. This paramete stops deployment regardless the active phase. By default it takes 1 Year from the deployment start date. You can specify deployments with a maximum period of 5 Years.

    assetId stringrequired

    Asset which will be deployed

    deployementFilter objectrequired

    Specifies the filter which will be used to target the device tags. If specified as empty, the deployment will be applicable to all devices in the project

    property name* string
    deploymentConfig object[]required

    Possible values: >= 1, <= 10

  • Array [
    • stageNumber integerrequired

    Possible values: >= 1 and <= 10

    Number of the stage when multiple stage are secified. You can specify maximum 10 stages.

    stageName string
    stageTarget integerrequired

    Number of device to target in this phase. If total devices are less than this number, the deployment will remain in this phase, and will not move to next phase.

    autoAbort booleanrequired

    Whether deployment should be aborted automatically at this stage based on number of failures specified in abortCriteria

    abortCriteria integerrequired
    delay integerrequired

    Delay before starting next phase

  • ]

Responses​

OK

Schema
    success boolean
    error string
    errorcode integer
    deploymentId string
Loading...