Home

statusapi

statusapi is an easy-to-use API to check the status of servers and websites.

Setup

The docker container needs "config" and optional "ssl" volumes. SSL should contain the following files:

• csr.pem
• key.pem
• server.crt

These files are for the SSL certificate.

Config

Config should contain the following files:

• "apikeys.json"
  formated like this:

[
    {
        "name": "priv",
        "endpoints": ["/", "/time", "/clients", "/clients/time", "/service", "/version", "/time/", "/clients/", "/clients/time/", "/service/", "/version/", "/login", "/login/", "/update", "/update/", "/clients/update", "/clients/update/", "/client/", "/client"],
        "key": "A4FmQ59LXt7eLr5HXr9CDlf4VaMNyqSWppIbFKhkZFCwHLzW733EAKqwWwGmfnV59qrBSje3qoS2seXwDnVehazMk935sD7Bgxl"
    },
    {
        "name": "null",
        "endpoints": ["/time", "/time/", "/version", "/version/"],
        "key": "null"
    },
    {
        "name": "login",
        "endpoints": ["/clients", "/clients/time", "/clients/", "/clients/time/", "/clients/update", "/clients/update/"],
        "key": "Sx5gpwNnOdD0vtx1x4Ymau4LowkCwurF0cWWSc8b2Ns4gBZ177ZUtPSQo1LwS63qOg2jKSPhFFK6gGJ4ev7SmX9WIi1K4caz7NC"
    }
]

• "tests.json"
  formated like this:

[
    {"name":"iptocheck",        "adres":"123.123.123.123",       "type":0,   "status":0},
    {"name":"websitetocheck",   "adres":"https://website.com",   "type":2,   "status":0}
]

• "users.json"
  formated the same way as tests.json

---

Formating

"type"

• 0 => ip-check
• 1 => http-check
• 2 => https-check

Ports

http runs on port 8284 by default
https runs on port 8285 by default