API Dokumentacija

Tai yra dokumentacija apie prieinamus API galutines taškas, kurios yra sukurtos pagal REST architektūrą. Visi API galutiniai taškai grąžins JSON atsakymą su standartiniais HTTP atsakymo kodais ir reikalingas Bearer autentifikacija naudojant API raktą.

 
Get your own API Key

Autentifikacija

Visi API galutinės taško taškai reikalauja API rakto, išsiųsto naudojant Bearer autentifikacijos metodą.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://alarm.lt/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "Jums n\u0117ra prieigos prie API.",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
All API endpoint results work with the UTC timezone unless specified otherwise.
User
Stebėtojai
DNS monitors
Serverių monitoringas
Heartbeat'ai
Domenai
Game servers
Notification handlers
Būsenos puslapiai
Status page statistics
Incidents
Savo domenai
Paskyros žurnalai