API Documentation

https://api.miniborlink.com

GET /api/status

Aggregierter System-Status in einem Satz.

curl https://api.miniborlink.com/api/status

Response 200

{
  "data": {
    "status": "operational",
    "message": "All Systems Operational"
  }
}

Moegliche status-Werte

Wert	Bedeutung
operational	alles laeuft
performance_issues	spuerbar langsamer / instabil
partial_outage	Teil-Ausfall
major_outage	kompletter Ausfall
under_maintenance	Wartung laeuft

GET /api/components

Listet alle Komponenten (Web, API, DNS, ...) mit ihrem aktuellen Status.

Query-Parameter

Param	Typ	Default	Beschreibung
sort	string	-	name, order, id - mit - fuer DESC
include	string	-	group, incidents (komma-separiert)
per_page	integer	15	Items pro Seite
page	integer	1	Seitennummer
filter[status]	1..6	-	Filter nach Status-Enum
filter[name]	string	-	Filter nach Name
filter[enabled]	boolean	-	Filter nach enabled

curl 'https://api.miniborlink.com/api/components?per_page=50&include=group'

Response 200 (gekuerzt)

{
  "data": [
    {
      "id": "1",
      "type": "components",
      "attributes": {
        "id": 1,
        "name": "Main Web",
        "description": "...",
        "status": { "human": "Operational", "value": "operational" },
        "enabled": true
      },
      "relationships": {
        "group": { "data": { "type": "componentGroups", "id": "1" } }
      }
    }
  ],
  "links": { "first": "...", "last": "...", "prev": null, "next": null },
  "meta":  { "current_page": 1, "from": 1, "to": 4, "per_page": 15 },
  "included": [ /* ComponentGroups falls include=group */ ]
}

GET /api/incidents

Liste der Incidents, neueste zuerst. Per Default werden alle (auch abgeschlossene) zurueckgegeben.

Query-Parameter

Param	Typ	Default	Beschreibung
sort	string	-	name, status, id (mit - fuer DESC)
include	string	-	components, updates, user
per_page	integer	15	Items pro Seite
page	integer	1	Seitennummer
filter[status]	string	-	Filter nach Status
filter[name]	string	-	Filter nach Name

curl 'https://api.miniborlink.com/api/incidents?per_page=15&include=components,updates'

GET /api/metrics/{metric}/points/{metricPoint}

Holt einen einzelnen Metric Point (z.B. fuer eigene Auswertungen / Graphen).

Path-Parameter

Param	Typ	Beschreibung
metric	integer	ID der Metric
metricPoint	integer	ID des Metric Points

curl https://api.miniborlink.com/api/metrics/1/points/42

Response 200 (gekuerzt)

{
  "data": {
    "id": "42",
    "type": "metricPoints",
    "attributes": {
      "id": 42,
      "metric_id": 1,
      "value": 17,
      "calculated_value": "17",
      "counter": 1,
      "created": { "human": "1 minute ago", "string": "..." }
    }
  }
}