Skip to main content

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

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
    type object

Responses​

Schema

    action string

    Manifest action this status belongs to (install for legacy and V1 deploys).

    catalogId stringrequired
    completedAt date-timenullable
    currentTime date-timenullable
    deviceId stringrequired
    eta int64nullable
    messageLog stringnullable

    Progress/status log. For a Deploy V2 component this is a JSON string of the DeployV2StatusLog struct (parse it for per-task messages and any error); for legacy deploys it is plain text.

    progress int32nullable
    requestedStatus object
    startedAt date-timenullable
    status object
    stoppedAt date-timenullable
    type ItemTyperequired

    Possible values: [software, map, cache, config]

Loading...