Get a workflow
Returns one tracked workflow with its state, and the reason why it cannot be stopped now, if any.
/api/v1/workflows/{id}tse_sessionAPI key · cookierequiredidstringrequiredOK
database_service_idstringrequireddcs_cluster_idstringfinished_atstringidstringrequiredlast_heartbeatstringrequiredmember_namestringThe member slot of a release or a rebuild.
operationstringrequiredstarted_atstringrequiredstarts_backupbooleanThe 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.
statusstringrequiredrunningcompletedfailedtimeoutinterruptedstop_refusalstringWhy 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_kindstringdatabase_servicedcs_clusterstanzaservertarget_namestringwarningstringWhat 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>.
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message