Updates deployment status for third-party installers.

PUT 
/api/v2/deploy/:catalog_id

Allows third-party installers to update the deployment status, progress, and messages for a component identified by catalog_id. This endpoint is used for external deployment tracking.

Request

Path Parameters

catalog_id stringrequired

Catalog ID of the component

application/json

Body

required

estimateTime int64nullable
eventTime date-timenullable

The time when the deployment event occurred (stopped, started, etc.)

messageLog stringnullable
progress int32nullable

Possible values: <= 100

status object

Responses

200

application/json

Schema

Schema

catalogId stringrequired
completedAt date-timenullable
currentTime date-timenullable
deviceId stringrequired
eta int64nullable
messageLog stringnullable
progress int32nullable
requestedStatus object
startedAt date-timenullable
status object
stoppedAt date-timenullable
type ItemTyperequired

Possible values: [software, map, cache]

Example (from schema)

{
  "catalogId": "string",
  "completedAt": "2026-03-12T11:20:53.434Z",
  "currentTime": "2026-03-12T11:20:53.434Z",
  "deviceId": "string",
  "eta": 0,
  "messageLog": "string",
  "progress": 0,
  "requestedStatus": "Start",
  "startedAt": "2026-03-12T11:20:53.434Z",
  "status": "Start",
  "stoppedAt": "2026-03-12T11:20:53.435Z",
  "type": "software"
}

500

application/json

Schema

Schema

message stringrequired
name stringrequired
statusCode int32required

Example (from schema)

{
  "message": "string",
  "name": "string",
  "statusCode": 0
}

Loading...