Skip to content
OTA-Pulse Docs

Get Rollout

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

Current state of one phased-rollout group.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
rollout_id
required
Rollout Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
RolloutGroupResponse

Phased-rollout group status (GET /api/rollouts/{id})

object
batch_count
required
Batch Count
integer
batch_index
required
Batch Index
integer
created_at
required
Created At
string format: date-time
firmware_id
required
Firmware Id
string format: uuid
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
params
required
Params
object
key
additional properties
any
paused_reason
Any of:
string
state
required
RolloutState

State machine for a phased-rollout group (TODO-052/S56 design 3B).

string
Allowed values: active paused completed aborted
updated_at
required
Updated At
string format: date-time
Example 
{
  "state": "active"
}

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