Zum Inhalt springen

Es gelten dieselben Sichtbarkeitsregeln wie im Panel: Vollständig abgelaufene Dienste sind standardmäßig ausgeblendet. Mit state filtern Sie nach dem Status, den das Panel anzeigt.

Ein unbekannter Parameter oder ein ungültiger Wert liefert 400 invalid_request; details.field nennt den betreffenden Parameter.

Der Listen-Endpoint enthält keine Statistiken. Er ist bewusst schlank gehalten, weil sonst für jeden Dienst das Backend abgefragt werden müsste; Nutzungsdaten liefert der Endpoint Dienstdetails.

Autorisierung

AuthorizationstringPflicht

Wird als Bearer <token> gesendet. Dieser Endpoint erfordert die Berechtigung orders:read (Dienstinformationen); ein Token ohne diese Berechtigung erhält 403.

Query-Parameter

typeenum<string>

Filtert nach Diensttyp.

statusstring

Filtert nach dem rohen Status.

stateenum<string>

Filtert nach dem Status, den das Panel anzeigt. Mit expired werden auch vollständig abgelaufene Dienste aufgelistet. Die Werte stehen auf der Seite Dienststatus.

limitintegerStandard: 25

Einträge pro Seite: 1-100. 0, negative oder nicht ganzzahlige Werte liefern 400; Werte über 100 werden auf 100 gesetzt (meta.limit zeigt den angewandten Wert).

offsetintegerStandard: 0

Anzahl der zu überspringenden Einträge.

include_expiredboolean

true listet auch vollständig abgelaufene und stornierte Dienste auf. Bei status=expired oder cancelled automatisch aktiv.

Antwort

200
application/json
dataobject[]
metaobject