foliot docs

API reference / Bulk / Stop a running bulk job

Stop a running bulk job

POST/apps/{appId}/bulk/{id}/cancel

Authenticate with an operator token or an app API key or a signed-in Foliot Console session.

Stops further work; runs already acted on stay as they are. Supply a reason and it is stored on the job as cancelReason; the body is optional and may be omitted.

Path parameters

appId
string
REQUIRED

The app's name.

id
string (uuid)
REQUIRED

The job's id.

Request body

reason
string
OPTIONAL

Why. Optional; recorded with the action.

max length 1000

Responses

200 object OK
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
503 Error A dependency this route needs is unreachable.