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

Authorization

AuthorizationBearer token · headerrequired

Path parameters

job_idstringrequired

Responses

200

Successful Response

_idstringrequired

namestringrequired

job_typeapp__models__api__agents_api_models__flink_jobs__FlinkJobTypeEnumrequired

Allowed:pyflinkjaragent_configknowledge_base

statusFlinkJobStatusEnumrequired

Allowed:CREATEDDEPLOYINGRUNNINGCANCELLINGCANCELLEDFAILEDFINISHED

desired_statusFlinkJobStatusEnum | null

Show properties

Any of:

FlinkJobStatusEnum

string

null

null

flink_job_namestringrequired

flink_job_idstring | null

Show properties

Any of:

string

string

null

null

parallelisminteger

default: 1

error_messagestring | null

Show properties

Any of:

string

string

null

null

agent_configobject | null

Show properties

Any of:

object

object

null

null

created_bystring | null

Show properties

Any of:

string

string

null

null

created_timestampstring<date-time> | null

Show properties

Any of:

string<date-time>

string<date-time>

null

null

updated_timestampstring<date-time> | null

Show properties

Any of:

string<date-time>

string<date-time>

null

null

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X POST 'https://api.streamkap.com/agents/string/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.streamkap.com/agents/string/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://api.streamkap.com/agents/string/cancel",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "_id": "string",
  "name": "string",
  "job_type": "pyflink",
  "status": "CREATED",
  "desired_status": "CREATED",
  "flink_job_name": "string",
  "flink_job_id": "string",
  "parallelism": 1,
  "error_message": "string",
  "agent_config": {},
  "created_by": "string",
  "created_timestamp": "2019-08-24T14:15:22Z",
  "updated_timestamp": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}