foliot docs

API reference / Apps / Register an app

Register an app

POST/apps

Authenticate with an operator token.

Operator only: an app minting its own credentials would defeat the point of having them issued. The app belongs to no workspace; a person registers into theirs with POST /workspaces/{workspaceId}/apps.

Request body

description
string
OPTIONAL

max length 500

handlerBaseUrl
string (uri)
REQUIRED

Where tasks are pushed.

name
string
REQUIRED

The app's name. With POST /apps it also becomes the app's id; in a workspace the id is generated and the name only has to be unique in that workspace. Lower-case kebab.

min length 1 · max length 100 · pattern ^[a-z0-9][a-z0-9-]*$

Responses

201 object Created
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.