Changes the deployment state of a component identified by catalog_id.

POST 
/deploy/changeItemState/:catalog_id

Changes the deployment state based on the provided state change object and returns the updated deployment information.

Request

Path Parameters

catalog_id stringrequired

application/json

Body

required

deviceId stringrequired
requestedStatus DeploymentStatusrequired

Possible values: [Start, Done, Installing, Continue, Pause, Cancelled, Error, Uninstall]

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-01-01T11:09:05.916Z",
  "currentTime": "2026-01-01T11:09:05.916Z",
  "deviceId": "string",
  "eta": 0,
  "messageLog": "string",
  "progress": 0,
  "requestedStatus": "Start",
  "startedAt": "2026-01-01T11:09:05.916Z",
  "status": "Start",
  "stoppedAt": "2026-01-01T11:09:05.916Z",
  "type": "software"
}

500

application/json

Schema

Schema

message stringrequired
name stringrequired
statusCode int32required

Example (from schema)

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

Loading...