Skip to content
OTA-Pulse Docs

List Deployments

GET
/api/firmware/{firmware_id}/deployments
 
curl --request GET \
  --url 'https://example.com/api/firmware/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deployments?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>'

List deployments for a firmware version

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
firmware_id
required
Firmware Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid
status
Any of:
DeploymentStatus

Deployment status for individual devices

string
Allowed values: scheduled pending downloading downloaded installing installed failed rolled_back

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
Response List Deployments Api Firmware Firmware Id Deployments Get
Array<object>
FirmwareDeploymentResponse

Firmware deployment status

object
completed_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
device
Any of:
DeviceShort

Short device info for deployment response

object
device_id
required
Device Id
string
firmware_version
Any of:
string
id
required
Id
string format: uuid
name
required
Name
string
status
required
Status
string
device_id
required
Device Id
string format: uuid
error_message
required
Any of:
string
firmware_id
required
Firmware Id
string format: uuid
from_version
required
Any of:
string
id
required
Id
string format: uuid
paused_at
Any of:
string format: date-time
progress
required
Progress
number
retry_count
required
Retry Count
integer
rollout_batch
Any of:
integer
rollout_group_id
Any of:
string format: uuid
started_at
required
Any of:
string format: date-time
status
required
DeploymentStatus

Deployment status for individual devices

string
Allowed values: scheduled pending downloading downloaded installing installed failed rolled_back
to_version
required
To Version
string
Example 
[
  {
    "status": "scheduled"
  }
]

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}