Skip to content
OTA-Pulse Docs

Download deployment artifact

GET
/api/devices/v1/deployments/{deployment_id}/download
 
curl --request GET \
  --url https://example.com/api/devices/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/download

Download firmware artifact for a deployment.

Authenticated via a short-lived signed token embedded in the download URL (pre-signed URL pattern). The token is issued by the deployment- check endpoint and scoped to a single deployment_id.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
deployment_id
required
Deployment Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
token
Any of:
string

Header Parameters

Section titled “ Header Parameters ”
Range
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
Example generated 
example

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