Deletions

Get a deletion

GET/deletions/{task_id}

ModelsExpandCollapse

DeletionBlockedReason = "fk_dependency" or "settlement_pending" or "shared_bytes" or 3 more

Why a deletion task is blocked; null unless its state is blocked.

One of the following:

"fk_dependency"

"settlement_pending"

"shared_bytes"

"external_error"

"dependency_cancelled"

"operator_hold"

DeletionPhase = "stopping" or "discovering" or "waiting_for_children" or 2 more

The last execution phase a deletion task reached; null before the task first runs and once it is completed.

One of the following:

"stopping"

"discovering"

"waiting_for_children"

"deleting"

"verifying"

DeletionState = "waiting" or "scheduled" or "queued" or 5 more

Lifecycle state of a deletion task. completed and cancelled are terminal; every other state is active. Only completed means the content was removed.

One of the following:

"waiting"

"scheduled"

"queued"

"running"

"retry_wait"

"blocked"

"completed"

"cancelled"

DeletionTask = object { id, blocked_reason, completed_at, 9 more }

One generation deletion task, as returned by DELETE /generations/{generation_id} and GET /deletions/{task_id}. See the Generation deletion guide for what each state, phase and blocked reason means.

id: string

Deletion task identifier. Poll it with GET /deletions/{task_id}.

format: uuid

blocked_reason: DeletionBlockedReason

Why a deletion task is blocked; null unless its state is blocked.

One of the following:

"fk_dependency"

"settlement_pending"

"shared_bytes"

"external_error"

"dependency_cancelled"

"operator_hold"

completed_at: string

When the task completed; set only when state is completed.

format: date-time

delete_deadline: string

The deadline recorded on the task, if any.

format: date-time

overdue: boolean

True when delete_deadline passed before the task completed, or the task completed after it. Does not change state.

phase: DeletionPhase

The last execution phase a deletion task reached; null before the task first runs and once it is completed.

One of the following:

"stopping"

"discovering"

"waiting_for_children"

"deleting"

"verifying"

requested_at: string

When the deletion was requested.

format: date-time

resource_id: string

The id of the generation the task deletes.

resource_type: "generation"

The kind of resource the task deletes — always generation.

One of the following:

"generation"

scheduled_at: string

When the task is or was due to run. A task created by DELETE is due when it is accepted.

format: date-time

state: DeletionState

Lifecycle state of a deletion task. completed and cancelled are terminal; every other state is active. Only completed means the content was removed.

One of the following:

"waiting"

"scheduled"

"queued"

"running"

"retry_wait"

"blocked"

"completed"

"cancelled"

updated_at: string

When the task last changed.

format: date-time