Skip to content
SupaCloud Docs
Select themeSelect language

`POST /api/tasks/{id}/undo` — record a new reversible undo action for the task, inside its grace window. A bad `kind` token -> 400; the service authz's the caller against the task's workspace and persists the `state='grace'` row.

POST
/api/tasks/{id}/undo
curl --request POST \
  --url https://example.com/api/tasks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/undo \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "kind": "example", "payload": {}, "run_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Task ID to arm an undo action for

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The create-undo request body: the reversal kind plus the kind-specific reversal inputs (payload, e.g. the PR number / deployment id / release tag).

object
kind
required
string
payload
object
run_id
string | null format: uuid
Examplegenerated
{
  "kind": "example",
  "payload": {},
  "run_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “Responses”

200

Section titled “200”

The persisted grace-window undo action

Media typeapplication/json

One persisted task_undo_actions row — the durable undo/rollback record. payload/result stay raw serde_json::Value so a forward-compatible shape round-trips without a schema bump (mirrors TaskToolApproval).

object
created_at
required
string format: date-time
created_by
string | null format: uuid
executed_at
string | null format: date-time
grace_until
string | null format: date-time
id
required
string format: uuid
kind
required

The reversal class. Runtime String; the spec narrows it to the closed [UndoKind] (revert_pr | reverse_deploy | redeploy_last_good).

string
Allowed values: revert_pr reverse_deploy redeploy_last_good
payload
required

The raw reversal input (forward-compatible). Runtime stays serde_json::Value; the spec types it as an open map.

object
key
additional properties
result

The reversal outcome (e.g. result.pr_url), forward-compatible. Runtime stays serde_json::Value; the spec types it as an open map.

object | null
run_id
string | null format: uuid
state
required

The lifecycle state. Runtime String; the spec narrows it to the closed [UndoState] (pending | grace | executed | expired | failed).

string
Allowed values: pending grace executed expired failed
task_id
required
string format: uuid
Example
{
  "kind": "revert_pr",
  "state": "pending"
}

400

Section titled “400”

Invalid undo kind

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

404

Section titled “404”

Task not found

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}