Instance

Delete instance

DeleteInstance empties it and returns it to first run. Admins only, and there is no undo: Nooks keeps no backup of its own.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

password?string

The Admin's own password. An unattended browser is the realistic way this happens by accident, and a name can be read off the screen in front of you.

instanceName?string

The Instance's name, typed out, so that whoever is doing this has read what they are about to lose.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/instance:delete" \  -H "Content-Type: application/json" \  -d '{}'

{}

Get public list

GetPublicList returns the published List, or nothing when there is none. It is the only List reachable this way: a Visitor cannot ask for another one, and cannot discover that another one exists.

Get instance

GetInstance returns the public profile of this Instance. It is reachable without authentication because the sign-in page and the Public list both need it before anyone has signed in.

Delete instance

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`