Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get a workflow

Returns one tracked workflow with its state, and the reason why it cannot be stopped now, if any.

GET/api/v1/workflows/{id}
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

database_service_idstringrequired
dcs_cluster_idstring
finished_atstring
idstringrequired
last_heartbeatstringrequired
member_namestring

The member slot of a release or a rebuild.

operationstringrequired
started_atstringrequired
starts_backupboolean

The end of the workflow starts a full backup of the service: a restore, a deploy of a service with no PostgreSQL, or a major upgrade, its rollback or its stanza step whose end starts one, also when it failed. A running deploy or restore has it when its completion starts the backup; a deploy or a restore that ended without completing does not have it.

statusstringrequired
Allowed:runningcompletedfailedtimeoutinterrupted
stop_refusalstring

Why the console refuses to stop this running workflow now (a major upgrade in its maintenance window). POST /workflows/{id}/kill and DELETE /workflows/{id} give 409 with this text.

target_kindstring
Allowed:database_servicedcs_clusterstanzaserver
target_namestring
warningstring

What the operator must know about a completed workflow. A backup that completed, but whose expire step failed, gives: Backup completed. Old backups and WAL were not removed: <pgBackRest message>.

default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/workflows/string' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "database_service_id": "string",
  "dcs_cluster_id": "string",
  "finished_at": "string",
  "id": "string",
  "last_heartbeat": "string",
  "member_name": "string",
  "operation": "string",
  "started_at": "string",
  "starts_backup": true,
  "status": "running",
  "stop_refusal": "string",
  "target_kind": "database_service",
  "target_name": "string",
  "warning": "string"
}