Skip to main content
ZStack
Infrastructure/Lifecycle

UpdateComponent

Trigger an asynchronous in-place update of a deployed component

POST/api/v1/lifecycle/components/{uuid}/update

Operation ID

UpdateComponent

Since

1.0.0

Execution Mode

Asynchronous

Auth Context

Auth Required

Async Workflow

This endpoint starts asynchronous work.

Expect an initial acceptance response first, then follow the workflow-specific identifier or task status from the response payload.

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • uuid
    StringRequired

    UUID of the component to update

Body Fields

  • targetVersion
    StringRequired

    Target version to update the component to

    Example: 1.3.0

  • targetRelease
    StringRequired

    Target release to update the component to

    Example: 221

  • componentInstanceUuid
    StringRequired

    Optional component instance UUID for HA components

    Example: inst-a1b2c3d4

  • params
    StringRequired

    Additional parameters as key-value pairs

    Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task ID tracking the asynchronous update operation

    Example: task-a1b2c3d4-e5f6-7890-abcd-ef1234567890

Change History

View all change history

  • Change Time

    AddedRequest body fields componentInstanceUuid
    View API