tessera

The scanner's state, and how much is waiting on it.

GET
/api/v1/admin/scanner

Errors

401 when nothing was signed in, 403 when the caller may not read settings, 404 when this instance has no administration.

session
cookietessera_session<token>

Set by POST /auth/login. A browser sends it automatically; it is HttpOnly, so page scripts cannot read or set it.

Response Body

The scanner's state

application/json
  1. response

Body of GET /admin/scanner.

deferred*integer

Files and notes the scanner could not be reached for, served unscanned and retried until it answers.

Formatint64
Range0 <= value
enabled*boolean

Whether scan.url names a scanner. When false the rest says nothing about one.

last_checked_at?|

When it was last called, or null before it has been since start-up or since scan.url changed.

Formatdate-time
last_error?|

Why the last call failed, or null when it answered.

pending*integer

Files and notes waiting on their first verdict, held until it comes.

Formatint64
Range0 <= value
reachable*boolean

Whether it answered the last time it was called, or true before it has been.

Learned from the scans themselves; one left idle is sent an empty file every fifteen minutes, and one that failed every five.

curl -X GET 'https://example.com/api/v1/admin/scanner'
{  "deferred": 0,  "enabled": true,  "last_checked_at": "2019-08-24T14:15:22Z",  "last_error": "string",  "pending": 0,  "reachable": true}