What's New?Connect Agent Releases Pricing

Deployments

JFrog Connect API requests that deploy software, retrieve information about deployments, or abort deployments.

Last updated 2 days ago

Was this helpful?

Get Deployment by UUID

Returns information about the requested deployment, including the time it was created, the CVE severities, the UUID, the comment entered at creation time, and the deployment type.

get

/api/v2/{project_key}/deployments/{deployment_uuid}

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

deployment_uuidstringrequired

The UUID of the deployment you are acting on. This is a unique identifier in Connect, for example, dp-e6a5-7e19, and can be found in the web UI in the Deployments table.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments/{deployment_uuid}' \
  --header 'Authorization: Bearer JWT'

200

404

{
  "comment": "",
  "created_time": "2023-01-09 12:03:28",
  "cve_severity": null,
  "Critical": 0,
  "High": 0,
  "Low": 0,
  "Medium": 0,
  "deployment_uuid": "dp-e6a5-7e19",
  "type": "manual"
}

Get Deployment Status on Devices

Returns the status of the deployment on the devices included in the deployment. The status information includes the start and finish time of the deployment on each device, the deployment status (success or failure), and the status of each action block (steps) included in the update flow.

get

/api/v2/{project_key}/deployments/{deployment_uuid}/devices

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

deployment_uuidstringrequired

The UUID of the deployment you are acting on. This is a unique identifier in Connect, for example, dp-e6a5-7e19, and can be found in the web UI in the Deployments table.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments/{deployment_uuid}/devices' \
  --header 'Authorization: Bearer JWT'

200

404

{
  "pagination_info": {
    "after": "eyJjdXJzb3IiOiA0OTEsICJsaW1pdCI6IDN9",
    "total": 3
  },
  "deployment_by_device_uuid": {
    "2c55-e275": {
      "finished_time": null,
      "started_time": null,
      "status": "Pending"
    },
    "435d-3443": {
      "finished_time": null,
      "started_time": null,
      "status": "Pending"
    },
    "a72c-b016": {
      "finished_time": null,
      "started_time": null,
      "status": "Pending"
    }
  }
}

Get Deployment Status on Device

Returns the status of a deployment on a specified device. The status information includes the start and finish time of the deployment on the device, the deployment status (success or failure), and the status of each action block (steps) included in the update flow.

get

/api/v2/{project_key}/deployments/{deployment_uuid}/devices/{device_uuid}

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

deployment_uuidstringrequired

The UUID of the deployment you are acting on. This is a unique identifier in Connect, for example, dp-e6a5-7e19, and can be found in the web UI in the Deployments table.

device_uuidstringrequired

The UUID of the device you are acting on. This is the unique identifier of the device in Connect, for example, d-4cfe-4e51. You can find the UUID in the ID column of the Devices table in the Devices page of the web UI.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments/{deployment_uuid}/devices/{device_uuid}' \
  --header 'Authorization: Bearer JWT'

200

404

{
  "summary": "200 OK Deployment status failed",
  "value": {
    "finished_time": "2024-03-26 15:09:05",
    "started_time": "2024-03-26 15:09:04",
    "status": "Failed",
    "steps": [
      {
        "exit_code": 0,
        "name": "Script Block",
        "stderr": "sh: 1: /usr/bin/python: not found\n",
        "stdout": "Script exited with bad exit-code: 127"
      }
    ]
  }
}

Abort Deployment

Aborts the deployment that you specify with the project key and the deployment UUID. This action stops the deployment to all devices that are in Pending state and tries to stop the deployments that are in In Progress state. The abort action does not affect devices that are already in Succeeded or Failed state.

Once the deployment has been aborted, the status of the devices is indicated as Aborted in the Status column of the Detailed Deployment Information page in the web UI.

post

/api/v2/{project_key}/deployments/{deployment_uuid}/abort

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

deployment_uuidstringrequired

The UUID of the deployment you are acting on. This is a unique identifier in Connect, for example, dp-e6a5-7e19, and can be found in the web UI in the Deployments table.

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments/{deployment_uuid}/abort' \
  --header 'Authorization: Bearer JWT'

201

{
  "message": "Deployment aborted successfully"
}

Created

Abort Device Deployment

Aborts the deployment to a specific device that you specify. You will need to specify the project key, the deployment UUID, and the device UUID. This action stops the deployment to the device if it is in Pending state and tries to stop a deployment that is in In Progress state. The abort action will not affect a device if it is already in Succeeded or Failed state.

Once the deployment has been aborted, the status of the device is indicated as Aborted in the Status column of the Detailed Deployment Information page in the web UI.

post

/api/v2/{project_key}/deployments/{deployment_uuid}/devices/{device_uuid}/abort

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

deployment_uuidstringrequired

The UUID of the deployment you are acting on. This is a unique identifier in Connect, for example, dp-e6a5-7e19, and can be found in the web UI in the Deployments table.

device_uuidstringrequired

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments/{deployment_uuid}/devices/{device_uuid}/abort' \
  --header 'Authorization: Bearer JWT'

201

{
  "message": "Deployment for device aborted successfully"
}

Created

Get List of Deployments

Returns the list of deployments for the current user in the defined project. The record for each deployment includes the deployment UUID, the comment entered for the deployment, the CVE severities, the time the deployment was created, and the deployment type.

get

/api/v2/{project_key}/deployments

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

Query parameters

afterstring

Pagination token to get the next page of results

limitinteger · min: 1 · max: 1000 · default: 100

The maximum number of devices to return in the response

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments' \
  --header 'Authorization: Bearer JWT'

200

{
  "deployments": [
    {
      "comment": "",
      "created_time": "2023-01-09 12:03:28",
      "cve_severity": null,
      "Critical": 0,
      "High": 0,
      "Low": 0,
      "Medium": 0,
      "deployment_uuid": "dp-e6a5-7e19",
      "type": "manual"
    }
  ],
  "pagination_info": {
    "after": "text",
    "total": 1
  }
}

Deploy Update

Deploys an update flow that you have configured in the web UI. Use this API request to initiate an actual software update.

post

/api/v2/{project_key}/deployments

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

Body

deployment_configurationobject

An object that specifies the deployment parameters.

device_filterobject

An object that defines which devices in your fleet will be acted on.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/deployments' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"deployment_configuration":{"flow_uuid":"f-7b56-3336","comment":"test webhook 1","app":{"name":"default_app","version":"v1.1"},"parameters_mapping":{"username":"ubuntu","conf_path":"/etc/app/settings.conf"}},"device_filter":{"groups":[{"name":"Production"}],"filters":[{"type":"specific_device","operand":"is","value":"d-feaf-d9aa"},{"type":"deployment","deployment_id":"dp-9yl3-9ch7","operand":"is","value":"failed"},{"type":"app","app_version":"dp-9yl3-9ch7","operand":"is","value":"failed"}]}}'

201

{
  "deployment_uuid": "dp-22be-13ba"
}

Created