Skip to main content

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

Query Parameters

    force_resume boolean

    Force resume past persisted task-state drift after a manual install.yaml edit; combined with the release metadata flag forceResumeOnMismatch

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...