Skip to main content

Runs a named lifecycle action of a Deploy V2 release (install runs the standard deploy).

POST 
/api/v2/deploy/action/:catalog_id/:action

Returns 409 when that action is already running for the release.

Request​

Path Parameters

    catalog_id stringrequired

    Catalog ID of the release

    action stringrequired

    Manifest action to run (e.g. install, uninstall, restart, or a custom action name)

Query Parameters

    force_resume boolean

    Force resume past persisted task-state drift after a manual install.yaml edit

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