Skip to main content
POST
POST /v1/governance/workflowInstances/{id}/terminate

Terminate a Workflow Instance

Stop a governance workflow instance and record it as FAILURE. Only administrators can call this endpoint.
string
required
UUID of the workflow instance to terminate.
string
Why you are terminating the instance. Up to 1,000 characters. OpenMetadata adds it to the audit text of the termination, for example Terminated by <user>: <reason>.
The request has no body.
POST /v1/governance/workflowInstances/{id}/terminate

Returns

  • 200: The terminated workflow instance, recorded as FAILURE.
  • 202: A job of the instance’s periodic batch trigger is running on this server. OpenMetadata records a stop request and returns the instance that is still running. The batch sink stops before its next sub-batch and the trigger stops before its next batch. Then the instance is recorded as FAILURE.
Terminating an instance deletes every running process of that instance, including a process that a server locked and then stopped in the middle of a job. A lock that another running server holds can’t be told apart from that case, so that process is deleted too. For a workflow without a batch trigger, that job can keep applying side effects, such as entity updates, after the 200.

Error Handling