nooks
GitHubInstall
Instance

Get instance about

GetInstanceAbout reports what this copy of Nooks is and how much it holds. Any Member: it is their Instance too, and none of it is anybody else's business.

GET
/api/v1/instance/about

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/instance/about"
{  "version": "string",  "startedAt": "string",  "memberCount": 0,  "listCount": 0,  "itemCount": 0,  "storageBytes": "string",  "licence": "string",  "storageDriver": "string",  "instanceName": "string"}

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.

Get instance settings

GetInstanceSettings returns everything an Admin may change, including which List is public. Admins only: which List is published is not a fact a Visitor gets to read from the outside.