Initiates the deployment of a component identified by catalog_id.

POST 
/api/v2/deploy/start/:catalog_id

Triggers the deployment process for the specified component, either through the agent or a third-party installer. Returns the deployment information including status and progress.

Request

Path Parameters

catalog_id stringrequired

Catalog ID of the component to deploy

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.428Z",
  "currentTime": "2026-03-12T11:20:53.428Z",
  "deviceId": "string",
  "eta": 0,
  "messageLog": "string",
  "progress": 0,
  "requestedStatus": "Start",
  "startedAt": "2026-03-12T11:20:53.429Z",
  "status": "Start",
  "stoppedAt": "2026-03-12T11:20:53.429Z",
  "type": "software"
}

500

application/json

Schema

Schema

message stringrequired
name stringrequired
statusCode int32required

Example (from schema)

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

Loading...