easyNag API Documentation

Introduction

This documentation aims to provide all the information you need to work with the easyNag API.

Authenticating requests

To authenticate requests, include a parameter user_key in the body of the request.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Your User-Key can be located within the easyNag App. The notification will be broadcasted to all of your devices.

Push Notifications

Endpoints for sending push notifications

POST v1/push/alert

POST
https://api.easynag.com
/v1/push/alert
requires authentication

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.easynag.com/v1/push/alert" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_key\": \"abcdef1234567890abcdef1234567\",
    \"what\": \"SERVICE\",
    \"type\": \"PROBLEM\",
    \"state\": \"CRITICAL\",
    \"hostname\": \"www.example.com\",
    \"service\": \"fs_\\/\",
    \"output\": \"CRITICAL - 95.00% in use\",
    \"author\": \"Admin\",
    \"comment\": \"Ack\",
    \"date\": \"2022-06-02 20:00\",
    \"instance\": \"MyMonitoring\"
}"
Example response:
{
    "response": "Notification accepted"
}

POST v1/push/info

POST
https://api.easynag.com
/v1/push/info
requires authentication

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.easynag.com/v1/push/info" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_key\": \"abcdef1234567890abcdef1234567\",
    \"message\": \"Reminder - Scheduled maintenance will take place today. Ticket-ID: 1234567.\",
    \"silent\": false
}"
Example response:
{
    "response": "Notification accepted"
}