Skip to content
OTA-Pulse Docs

List All Deployments

GET
/api/deployments
 
curl --request GET \
  --url 'https://example.com/api/deployments?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&page=1&page_size=20' \
  --header 'Authorization: Bearer <token>'

List all deployments across all firmware versions

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid
page
Page
integer
default: 1 >= 1
page_size
Page Size
integer
default: 20 >= 1 <= 100
status
Any of:
DeploymentStatus

Deployment status for individual devices

string
Allowed values: scheduled pending downloading downloaded installing installed failed rolled_back
firmware_id
Any of:
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
Response List All Deployments Api Deployments Get
object
key
additional properties
any
Example generated 
{}

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"
    }
  ]
}