pause_instance
/instances/{instance_id}/pauseThe lineage-wide counterpart of cancel, without the finality. Every path
that would enqueue a workflow.tick is refused for the duration, so no
child spawns and nothing advances.
It does not recall work already queued. A model call, an email or a document parse already sitting on the queue for a node parked before the pause still runs — one per already-parked node, never a fan-out. Spend therefore ticks up briefly after a pause; that is the boundary, not a bug.
A service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.
In: header
Path Parameters
Instance id
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause"{ "already_terminal": 0, "paused": 0, "status": "running"}