Skip to content

API

A public API is exposed behind url /api. Except for some routes, they all need an authentication token

/#

GET

Returns a map of existing routes with their methods. Note that all routes have at least HEAD and OPTIONS methods.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "/": [
        "GET",
        "HEAD",
        "OPTIONS"
    ],
    "/health": [
        "HEAD",
        "OPTIONS"
    ]
}

/health#

HEAD

A simple route to check if API is alive. Will always return a 200.