Deployments
JFrog Connect API requests that deploy software, retrieve information about deployments, or abort deployments.
Was this helpful?
JFrog Connect API requests that deploy software, retrieve information about deployments, or abort deployments.
Was this helpful?
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.
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.
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.
{"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"}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.
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.
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.
{"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"}},"pagination_info":{"after":"eyJjdXJzb3IiOiA0OTEsICJsaW1pdCI6IDN9","total":3}}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.
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.
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.
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.
{"finished_time":"2024-06-25 15:05:44","started_time":"2024-06-25 15:05:43","status":"Success","steps":[{"exit_code":1,"name":"conan-artifact","stderr":"-","stdout":"-"}]}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.
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.
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.
Created
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.
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.
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.
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.
Created
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.
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.
Pagination token to get the next page of results
The maximum number of devices to return in the response
100OK
Deploys an update flow that you have configured in the web UI. Use this API request to initiate an actual software update.
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.
An object that defines which devices in your fleet will be acted on.
An object that specifies the deployment parameters.
Created