foliot docs

API reference / Runs / Patch a run's state

Patch a run's state

PATCH/apps/{appId}/runs/{runId}/state

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

Merges into the state map. A null VALUE deletes its key, which is the only way to remove one. Each value is held to the per-step size cap, measured as a step’s output is (a value over it is a 400 naming the key), and each key to the same number of bytes; the whole patch and the resulting state are not, so a run whose state has grown past the cap can still be repaired. Audited.

Path parameters

appId
string
REQUIRED

The app's name.

runId
string (uuid)
REQUIRED

Request body

patch
map of any
REQUIRED
reason
string
OPTIONAL

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.