Kill a background lens run
const url = 'http://localhost:11044/api/v1/lenses/runs/example/kill';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/lenses/runs/example/kill \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Best-effort stop; the run settles CANCELLED.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The background run to stop
Responses
Section titled “Responses”Not authenticated. The filter chain answers an ApiError; a principal that resolves to no user answers the refusal
A request-level refusal from the headless surface. Carries only the reason; an execution that ran and failed answers 200 with the outcome in its envelope instead
object
Why the request was refused, written to be shown: the unknown lens, view or run, the argument at fault, or the field the body should not have
A refusal with a machine-readable code and a plain-language message. ApiErrorAdvice answers it for a failed validation, a missing resource or a conflicting state, and some controllers answer it directly
object
Machine-readable key to branch on, such as validation_failed, unknown_field, not_found or conflict. Open: a surface may answer codes of its own
Extra context where there is some, such as the fields a body may carry; null otherwise
A plain-language explanation, written to be shown. Never carries an exception message
The body the servlet error dispatch answers for a status raised by an exception rather than written by the endpoint. Every failure except 404, which answers the not-found HTML page
object
The status’s standard reason phrase, such as Bad Request or Forbidden
The request path that failed
The HTTP status code, repeated from the status line
Example generated
{ "error": "example"}No such run for this user
A request-level refusal from the headless surface. Carries only the reason; an execution that ran and failed answers 200 with the outcome in its envelope instead
object
Why the request was refused, written to be shown: the unknown lens, view or run, the argument at fault, or the field the body should not have
Example generated
{ "error": "example"}