foliot docs

API reference / Apps / Update an app

Update an app

PATCH/apps/{appId}

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

An omitted field is left alone. A consequence worth knowing: description cannot be cleared through this path. The app’s own key, an operator token, or a signed-in person who is an owner of the app’s workspace (an operator or viewer is 403). Anyone but an operator token (an app key, or a person) must give a handlerBaseUrl that is https and not a private, loopback or link-local address (400 otherwise); a server run for development with FOLIOT_HANDLER_EGRESS=open checks only that it is an absolute http(s) URL without credentials.

Path parameters

appId
string
REQUIRED

The app's name.

Request body

description
string
OPTIONAL

max length 500

handlerBaseUrl
string (uri)
OPTIONAL

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.