mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-29 19:40:28 +00:00
95e6168839
See https://talk.tiddlywiki.org/t/logout-error-xmlhttprequest-error-code-404/5590/5 for details We can't POST to the logout endpoint without triggering authentication, so we report in advance whether logout is supported.
45 lines
1.0 KiB
Plaintext
45 lines
1.0 KiB
Plaintext
created: 20181002125229601
|
|
modified: 20181002125840235
|
|
tags: [[WebServer API]]
|
|
title: WebServer API: Get Server Status
|
|
type: text/vnd.tiddlywiki
|
|
|
|
Get server status information
|
|
|
|
```
|
|
GET /status
|
|
```
|
|
|
|
Parameters:
|
|
|
|
* none
|
|
|
|
Response:
|
|
|
|
* 200 OK
|
|
*> `Content-Type: application/json`
|
|
*> Body: see below
|
|
|
|
The JSON data returned comprises the following properties:
|
|
|
|
* ''username'' - the username of the currently authenticated user. If undefined, the [[WebServer Parameter: anon-username]] is returned instead
|
|
* ''anonymous'' - true if the current user is anonymous
|
|
* ''read_only'' - true if the current user is restricted to read only access to the server
|
|
* ''logout_is_available'' - true if the server supports logging out (optional, defaults to true)
|
|
* ''space'' - always contains the object `{recipe: "default"}`
|
|
* ''tiddlywiki_version'' - the current TiddlyWiki version
|
|
|
|
For example:
|
|
|
|
```
|
|
{
|
|
"username": "",
|
|
"anonymous": true,
|
|
"read_only": false,
|
|
"space": {
|
|
"recipe": "default"
|
|
},
|
|
"tiddlywiki_version": "5.1.18"
|
|
}
|
|
```
|