Skip to content

Cancel a fill — completed chunks stay cached; nothing is rolled back

DELETE
/api/v1/admin/kg/fills/{id}
curl --request DELETE \
--url http://localhost:11044/api/v1/admin/kg/fills/example \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'
id
required
string

The fill’s id (fill_ plus 12 characters), as start or list returned it, matched only among the acting user’s fills; an id that matches nothing is not refused and still answers CANCELLED

username
string

Username to act as; when it resolves to a user it is used in preference to the authenticated principal. Omitted or blank, the authenticated principal acts; 401 when neither resolves

The cancelled fill’s id and its new state

Media typeapplication/json

A cancelled fill: which one, and the state it is now in

object
id
required

The fill’s id, echoed back unchanged

string
state
required

Always CANCELLED. Completed chunks stay cached and nothing is rolled back, so this says the fill stopped rather than that its work was undone

string

Example

{
"state": "CANCELLED"
}

No authenticated principal and no resolvable username

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"
}