Sign in

v3

latestOpenAPI 3.1.0Proprietary2026-08-07266348629.6 KB
Agents

Update Agent Config

Update a config-based agent's config and redeploy.

Merges the provided fields into the existing config, then triggers savepoint -> cancel -> redeploy with the new config. The caller's email is recorded on the paired history row (M3) - for admin-app mode this is the admin's email, not the tenant user's.

put/agents/{job_id}/config

Path parameters

job_idstring required

Request body

descriptionstring nullable

Human-readable context for the agent

enabledboolean nullable

Kill switch — set false to disable output emission without cancel/redeploy.

changeNotestring nullable

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