foliot docs

API reference / Apps / Delete an app

Delete an app

POST/apps/{appId}/delete

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

An operator token, or a signed-in person who is an owner of the app’s workspace. Never an app key. The app disappears from every list and read at once, its API key stops authenticating, nothing more is pushed to its handler, and every operation on it answers 404 as for an app that does not exist, except restoring and purging it. Nothing it owns is removed yet: it can be restored until purgeAfter (30 days), when it is purged with everything it owns. Refused with 409 while the app has a run that is running, sleeping or waiting, or a bulk job that has not finished: cancel those first. Its name is free for a new app in the workspace straight away. The reason is required and recorded, with the caller as the actor, in the app’s credential history and on the deleted app.

Path parameters

appId
string
REQUIRED

The app's id.

Request body

reason
string
REQUIRED

Why. Required, and recorded.

min length 8 · 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.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.