Admin — provisioning workflows

4 endpoints in this group. All paths are prefixed with /api/v1.

Endpoints in this group#

• GET /api/v1/admin/provisioning/workflows — Admin List Workflows
• POST /api/v1/admin/provisioning/workflows/{workflow_id}/force-complete — Admin Force Complete
• POST /api/v1/admin/provisioning/workflows/{workflow_id}/retry-step/{step_name} — Admin Retry Step
• POST /api/v1/admin/provisioning/workflows/{workflow_id}/rollback — Admin Rollback Workflow

GET /api/v1/admin/provisioning/workflows — Admin List Workflows {#get-api-v1-admin-provisioning-workflows}#

List all provisioning workflows across all tenants.

Parameters:

• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_WorkflowResponse__ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

POST /api/v1/admin/provisioning/workflows/{workflow_id}/force-complete — Admin Force Complete {#post-api-v1-admin-provisioning-workflows-workflow-id-force-complete}#

Force-complete a workflow, marking all non-terminal steps as skipped.

This is an admin escape hatch for stuck workflows. All pending, running, waiting_callback, and waiting_poll steps are marked as skipped, and the workflow is marked as completed.

Parameters:

• workflow_id (path, string, required)
• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_WorkflowDetailResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

POST /api/v1/admin/provisioning/workflows/{workflow_id}/retry-step/{step_name} — Admin Retry Step {#post-api-v1-admin-provisioning-workflows-workflow-id-retry-step-step-name}#

Retry a failed step in a workflow.

Resets the step to pending status with incremented retry count and re-runs execution.

Parameters:

• workflow_id (path, string, required)
• step_name (path, string, required)
• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_WorkflowDetailResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

POST /api/v1/admin/provisioning/workflows/{workflow_id}/rollback — Admin Rollback Workflow {#post-api-v1-admin-provisioning-workflows-workflow-id-rollback}#

Roll back a workflow by executing compensating actions in reverse order.

Parameters:

• workflow_id (path, string, required)
• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_WorkflowDetailResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}