Sign in
Agents

Cancel Agent

Gracefully cancel a running agent WITH savepoint.

Creates a savepoint before stopping - use this when you want to resume later. The savepoint path is stored and used automatically on redeploy.

post/agents/{job_id}/cancel

Path parameters

job_idstring required

Response

Successful Response

_idstring required
namestring required
job_type'pyflink' | 'jar' | 'agent_config' | 'knowledge_base' required
status'CREATED' | 'DEPLOYING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'FINISHED' required
desired_status'CREATED' | 'DEPLOYING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'FINISHED'
flink_job_namestring required
flink_job_idstring nullable
parallelisminteger
error_messagestring nullable
agent_configobject nullable
created_bystring nullable
created_timestampstring date-time nullable
updated_timestampstring date-time nullable

Changes

Changed in 1 of the 4 revisions of this API.1