STstreamkap
Knowledge Bases

Cancel Knowledge Base

Changed on

Cancel a running knowledge base (graceful, with savepoint).

post/knowledge-bases/{kb_id}/cancel

Request

Path parameters

kb_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

KB config (secrets masked)

created_bystring nullable
created_timestampstring date-time nullable
updated_timestampstring date-time nullable

Changes