Skip to main content
API Explorer|API Explorer
Infrastructure/Lifecycle
POSTLifecycleSince 1.0AsynchronousAsync WorkflowThis endpoint starts asynchronous work.Expect an initial acceptance response first, then follow the workflow-specific identifier or task status from the response payload.Auth Required

UpdateComponent

Trigger an asynchronous in-place update of a deployed component

Execution Availability

Mock execution is currently unavailable for this endpoint.

Async endpoints are not available for mock execution yet.

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the component to update

Body Fields

  • targetVersionStringRequired

    Target version to update the component to

    Example: 1.3.0

  • targetReleaseStringRequired

    Target release to update the component to

    Example: 221

  • paramsStringRequired

    Additional parameters as key-value pairs

    Example: value

Responses

200 OK

On success, this API returns the following response structure.

  • taskIdString

    Task ID tracking the asynchronous update operation

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

Endpoint

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

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

Operation ID

UpdateComponent

Permalink

Request Example

curl -X POST '{host}/api/v1/lifecycle/components/{uuid}/update' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"targetVersion":"1.3.0","targetRelease":"221","params":"value"}'

Response Example

200
{
  "taskId": "task-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Change History

This API has no change history records yet.

View all change history