Skip to main content
API Explorer|API Explorer
Infrastructure/Lifecycle
GETLifecycleSince 1.0SynchronousAuth Required

GetTask

Retrieve the current status and progress of a lifecycle task by ID

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • taskIdStringRequired

    ID of the task to retrieve

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the task

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

  • componentUuidString

    UUID of the component this task belongs to

    Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • componentInstanceUuidString

    UUID of the runtime component instance this task targets

    Example: abcdef0123456789abcdef0123456789

  • taskTypeString

    Type of task being executed

    Example: deploy

  • stateString

    Current execution state of the task

    Example: Running

  • progressInteger

    Completion progress as a percentage from 0 to 100

    Example: 42

  • messageString

    Human-readable message describing current task progress

    Example: Installing dependencies...

  • paramsString

    Additional parameters as key-value pairs

    Example: value

  • createDateString

    Create date

    Example: 2026-01-15T08:00:00Z

  • lastOpDateString

    Last op date

    Example: 2026-01-15T08:00:00Z

Endpoint

GET/api/v1/lifecycle/tasks/{taskId}

/api/v1/lifecycle/tasks/{taskId}

Operation ID

GetTask

Permalink

Request Example

curl -X GET '{host}/api/v1/lifecycle/tasks/{taskId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "uuid": "task-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "componentUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "taskType": "deploy",
  "state": "Running",
  "progress": 42,
  "message": "Installing dependencies...",
  "params": "example",
  "createDate": "example"
}

Change History

This API has no change history records yet.

View all change history