Skip to main content
Infrastructure/Lifecycle

DeployComponent

Trigger an asynchronous deployment of a registered component

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

Operation ID

DeployComponent

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 deploy

Body Fields

  • 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 deploy operation

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