aYOUne
← Monitoring API

Checks

Singular: Check — Base-URL: https://monitoring-api.ayoune.app — Zugriff: CRUD

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "optionalSettings": {
      "auth": {
        "username": "",
        "password": ""
      },
      "check": {
        "operator": "contains",
        "checkString": ""
      },
      "port": 443,
      "payload": "",
      "headers": []
    },
    "alertSettings": {
      "importance": "high",
      "users": [],
      "downAfter": 30,
      "alertDownAfter": 30,
      "message": ""
    },
    "_id": "65e0b15f121b7d48fe1595fb",
    "interval": 5,
    "countries": [
      "at",
      "it",
      "de",
      "se",
      "ch",
      "dk",
      "no",
      "be",
      "gb",
      "es",
      "za",
      "ru",
      "br",
      "us",
      "ae",
      "fr",
      "cz",
      "nl"
    ],
    "tags": [],
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:31:27.147Z",
    "updatedAt": "2024-02-29T16:31:27.147Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/checks/65e0b15f121b7d48fe1595fb",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a6194f9ae831600b931755b",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CHECK",
        "href": "https://api.ayoune.app/monitoring/checks/65e0b15f121b7d48fe1595fb/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CHECK",
        "href": "https://api.ayoune.app/monitoring/checks/65e0b15f121b7d48fe1595fb/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2430",
      "reset": "1784783607",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 94.255635,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /checks Liste mit Filtern/Paginierung monitoring.checks.view
GET /checks/:id Einzelner Datensatz monitoring.checks.view
POST /checks Neuen Datensatz erstellen monitoring.checks.new
PUT /checks Datensatz aktualisieren monitoring.checks.edit
DELETE /checks/:id Datensatz löschen monitoring.checks.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.monitoring.checks.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.monitoring.checks.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.monitoring.checks.create({ name: 'Foo' });

Weiterführend