Deploy Update
Deploy update
POST
https://api.connect.jfrog.io/v2/deploy_update
Using this call, you can deploy update flows on your devices. This is useful for CI/CD integrations and when you would like to deploy updates on your device fleet automatically.
Request Body
Name | Type | Description |
---|---|---|
user_token | string | This is your account token. Can be found under the Settings category on Connect dashboard. |
flow_id | string | This is the id of the update flow you created on Connect dashboard. You can find it at the |
devices_filter | object | A JSON object with the filter you would like to apply on your devices fleet. This filter will be applied and the result will be the devices that receive this update. The object has multiple keys:
1. |
parameters_mapping | String | Defines the update parameters values that are configured in the update flow.
|
deployment_configuration | String | A JSON object that defines the configuration that will be deployed with the update. |
comment | String | Set the |
app | String |
|
Possible types and values:
devices_filter
object:filters
key:Possible values for the
type
key:specific_device
- Set this value if you want to filter one specific device. The value of thevalue
key of this type is the ID of the device you want to filter (you can obtain the id on Connect dashboard). The possibleoperand
key values for this type are:is
,is_not
tag
- Set this value if you want to filter devices by a tag. The value of thevalue
key of this type is the name of the tag you want to filter (you can obtain the tag name on Connect dashboard). The possibleoperand
key values for this type are:is
,is_not
app
- Set this value if you want to filter devices by the apps that are set to them. The value of thevalue
key of this type is the app name. The possibleoperand
key values for this type are:is
,is_not
. Additionally, you can set anapp_version
property to filter to a specific app version.device_state
- Set this value if you want to filter devices by their state. The possible values of thevalue
key of this type are:online
,offline
. The possibleoperand
key value of this type is:is
deployment
- Set this value if you want to filter devices by thedeployment_id
and deployment status. The possible values forvalue
arepending
,in_progress
,success
,failed
,aborted
,any
. You must set thedeployment_id
property with the value from the deployments table on the platform.
All values must be of type: String
.
Full payload example:
Code Example
Last updated