Appearance
data.deploy.target.soft-delete
Soft-delete a DeploymentTarget — stops Orkestia tracking, leaves the workload on the cluster untouched.
Soft-delete a DeploymentTarget — stop tracking it, leave the workload on the cluster.
Overview
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-deployments |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the organization that owns the target |
deployment_target_uuid | uuid | Yes | — | UUID of the DeploymentTarget to stop tracking |
actor | string | No | — | ID of the user/agent initiating the soft-delete |
Output Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | Yes | — | UUID of the soft-deleted target |
deleted_at | string | No | — | ISO-8601 timestamp of the soft-delete |
already_deleted | boolean | Yes | — | True when the row was already soft-deleted before this run |
deleted | boolean | Yes | — | True when this run mutated the row |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Soft-delete DeploymentTarget |
completed | No | Yes | Yes | — | Deleted |
failed | No | Yes | No | — | Delete failed |
State Diagram
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
API Usage
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.deploy.target.soft-delete",
"initial_data": {
"organization_uuid": "value",
"deployment_target_uuid": "value"
}
}