Webserver HTTP API

curl -k -X POST https://<webserver>:8050/api/auth \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"yourPassword"}'

{
  "code": 200,
  "expire": "2026-03-28T12:00:00+01:00",
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

curl -k -X GET https://<webserver>:8050/api/users \
  -H "Authorization: Bearer <token>"

curl -k -X GET https://<webserver>:8050/refresh_token \
  -H "Authorization: Bearer <token>"

curl -k -X GET https://<webserver>:8050/refreshTokens \
  -H "Authorization: Bearer <token>"

curl --cacert /path/to/webserver/config/ssl/certificates/webserver.crt \
  -X POST https://<webserver>:8050/api/auth \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"yourPassword"}'

# Liveness check
curl -k https://<webserver>:8050/ping

# Service uptime
curl -k https://<webserver>:8050/uptime

curl -k -X POST https://<webserver>:8050/api/users \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "jsmith",
    "fullName": "John Smith",
    "email": "jsmith@example.com",
    "password": "SecureP@ss123",
    "accountType": "full",
    "group": "user",
    "enabled": "true",
    "tags": "Production,EU",
    "apps": "App1,App2",
    "maxAppsPerRow": 6,
    "horizontalSpacing": 5,
    "verticalSpacing": 15,
    "darkMode": "false"
  }'

curl -k -X PATCH https://<webserver>:8050/api/users \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "jsmith",
    "group": "admin",
    "enabled": "true",
    "tags": "Production,EU,US",
    "password": "NewP@ss456"
  }'

# Get current settings
curl -k -X GET https://<webserver>:8050/api/setting \
  -H "Authorization: Bearer <token>"

# List all components
curl -k -X GET https://<webserver>:8050/api/components \
  -H "Authorization: Bearer <token>"

# Get status of component "probe1"
curl -k -X GET https://<webserver>:8050/api/components/status/probe1 \
  -H "Authorization: Bearer <token>"

curl -k -X POST https://<webserver>:8050/api/components/probe \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "probe-paris",
    "os": "linux",
    "token": "<component_token>",
    "ip": "10.0.1.10",
    "port": "8051",
    "state": "true",
    "typeServer": "monitor",
    "logLevel": "info",
    "maxBackups": "5",
    "maxSize": "10",
    "maxAge": "28",
    "logCompress": "true",
    "dataRetention": "336",
    "purgeStatusChangeDataNb": "200",
    "concurrencyLimit": "20",
    "nbDaysBackup": "14",
    "backupInterval": "24",
    "chromeBinPath": "",
    "firefoxBinPath": "",
    "edgeBinPath": ""
  }'

# Disable component "probe1"
curl -k -X POST https://<webserver>:8050/api/components/disable/probe1 \
  -H "Authorization: Bearer <token>"

# Enable component "probe1" (type: monitor)
curl -k -X POST https://<webserver>:8050/api/components/enable/probe1/monitor \
  -H "Authorization: Bearer <token>"

curl -k -X POST https://<webserver>:8050/api/urls \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Homepage Check",
    "description": "Monitor the main website homepage",
    "url": "https://www.example.com",
    "probe": "probe-paris",
    "sched": "5MIN",
    "tags": "Production,Web",
    "state": "on",
    "timeout": "30",
    "retries": "2",
    "threshCri": "5000",
    "threshMaj": "3000",
    "threshMin": "1500",
    "certCheck": "on",
    "checkCertExp": "on",
    "nbDaysNotifCert": "30",
    "emailsNotifCert": "ops@example.com",
    "emailOnF": "true",
    "emailR": "ops@example.com",
    "emailOnSC": "true",
    "patternUrl": "Welcome",
    "patternComp": "string =="
  }'

# All URL statuses
curl -k -X GET https://<webserver>:8050/api/urls/status \
  -H "Authorization: Bearer <token>"

# Specific monitor
curl -k -X GET https://<webserver>:8050/api/urls/details/homepage-check \
  -H "Authorization: Bearer <token>"

# All non-OK monitors
curl -k -X GET https://<webserver>:8050/api/urls/ko \
  -H "Authorization: Bearer <token>"

# Run EUM monitor headlessly
curl -k -X GET "https://<webserver>:8050/api/monitors/run/my-monitor/false" \
  -H "Authorization: Bearer <token>"

# Stop a running monitor
curl -k -X POST https://<webserver>:8050/api/monitors/stop/my-monitor \
  -H "Authorization: Bearer <token>"

curl -k -X POST https://<webserver>:8050/api/tcps \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Redis Port 6379",
    "description": "Check Redis TCP port",
    "destIp": "10.0.1.20",
    "destPort": "6379",
    "probe": "probe-paris",
    "sched": "1MIN",
    "tags": "Production,Cache",
    "state": "on",
    "timeout": "5000",
    "retries": "2",
    "threshCri": "1000",
    "threshMaj": "500",
    "threshMin": "200",
    "emailOnF": "true",
    "emailR": "ops@example.com"
  }'

curl -k -X POST https://<webserver>:8050/api/pings \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Gateway Ping",
    "destIp": "10.0.0.1",
    "count": "5",
    "probe": "probe-paris",
    "sched": "1MIN",
    "tags": "Production,Network",
    "state": "on",
    "timeout": "5000",
    "retries": "2",
    "threshCri": "500",
    "threshMaj": "200",
    "threshMin": "100",
    "jitterThreshCri": "100000",
    "jitterThreshMaj": "50000",
    "jitterThreshMin": "20000",
    "emailOnF": "true",
    "emailR": "ops@example.com"
  }'

curl -k -X POST https://<webserver>:8050/api/nslookups \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "DNS Check example.com",
    "lookupName": "example.com",
    "probe": "probe-paris",
    "sched": "5MIN",
    "tags": "Production,DNS",
    "state": "on",
    "timeout": "5000",
    "retries": "2",
    "threshCri": "2000",
    "threshMaj": "1000",
    "threshMin": "500",
    "emailOnF": "true",
    "emailR": "ops@example.com"
  }'

curl -k -X POST https://<webserver>:8050/api/apps \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ecommerce-prod",
    "display_name": "E-Commerce Production",
    "description": "All production e-commerce monitors",
    "tags": "Production,Ecommerce",
    "apps": "Checkout,Catalog,Payment",
    "bRule": "or",
    "threshCri": "1",
    "threshMaj": "2",
    "threshMin": "3",
    "state": "on",
    "emailOnF": "true",
    "emailR": "ops@example.com",
    "emailOnSC": "true"
  }'

# Generate and send report by key
curl -k -X POST https://<webserver>:8050/genAndSendReport \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"key": "weekly-perf-report"}'

# Create a downtime window
curl -k -X POST https://<webserver>:8050/downtime/create \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "weekly-maintenance",
    "display_name": "Weekly Maintenance Window",
    "tags": "Production",
    "sched": "0 2 * * 0",
    "duration": "120",
    "state": "on"
  }'

# Generate a 1-year API key
curl -k -X POST https://<webserver>:8050/genAPIKey \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "cicd-pipeline",
    "ttl": "8760",
    "group": "admin"
  }'

# Revoke an API key
curl -k -X POST https://<webserver>:8050/revokeAPIKey \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"key": "cicd-pipeline"}'

# Backup the Webserver KV store
curl -k -X POST https://<webserver>:8050/backupDatabase \
  -H "Authorization: Bearer <token>"

# Backup probe "probe1" KV store
curl -k -X POST https://<webserver>:8050/backupDatabase/probe1 \
  -H "Authorization: Bearer <token>"

# List all keys in the "user" bucket
curl -k -X GET https://<webserver>:8050/webserver/user/allK \
  -H "Authorization: Bearer <token>"

"sched": "CRON",
"schedCron": "0 8 * * 1-5"

#!/bin/bash
WEBSERVER="https://webserver.example.com:8050"
CACERT="/path/to/webserver.crt"  # or use -k for testing

# 1. Authenticate
TOKEN=$(curl -s --cacert "$CACERT" -X POST "$WEBSERVER/api/auth" \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"yourPassword"}' \
  | jq -r '.token')

if [ -z "$TOKEN" ] || [ "$TOKEN" = "null" ]; then
  echo "Authentication failed"
  exit 1
fi

# 2. Make API calls
curl -s --cacert "$CACERT" -X GET "$WEBSERVER/api/urls/status" \
  -H "Authorization: Bearer $TOKEN" \
  | jq .

# 3. Get all non-OK monitors across all types
for TYPE in urls apis monitors tcps pings nslookups dbs snmps syss; do
  echo "=== NON-OK $TYPE ==="
  curl -s --cacert "$CACERT" -X GET "$WEBSERVER/api/$TYPE/ko" \
    -H "Authorization: Bearer $TOKEN" \
    | jq .
done