Cancel an in-flight run by id (owner-guarded)
POST
/api/v1/admin/kg/kill/{runId}
const url = 'http://localhost:11044/api/v1/admin/kg/kill/example';const options = {method: 'POST', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:11044/api/v1/admin/kg/kill/example \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”runId
required
string
The run handle returned by a background or timed-out execution.
Query Parameters
Section titled “Query Parameters”username
string
Optional, and never needed: the call always acts as the signed-in principal. Naming the principal changes nothing; naming anyone else is refused with 403.
Responses
Section titled “Responses”Whether the kill landed
Media typeapplication/json
The outcome of a kill request.
object
killed
required
False when the run had already settled, or was never the caller’s.
boolean
runId
required
The run id from the path, echoed back.
string
Example generated
{ "killed": true, "runId": "example"}No authenticated principal
Media typeapplication/json
A refusal carrying only a human-readable reason.
object
error
required
What went wrong, in the terms the caller can act on.
string
Example generated
{ "error": "example"}username names someone other than the signed-in principal
Media typeapplication/json
A refusal carrying only a human-readable reason.
object
error
required
What went wrong, in the terms the caller can act on.
string
Example generated
{ "error": "example"}