MetriBeacon
Menü
Deutsch

POST Vorlage atomar im eigenen Arbeitsbereich anwenden

/api/v1/templates/apply

Wendet eine Vorlage atomar innerhalb der Kontogrenzen an. Server/NAS v2 reserviert Monitor, Reihen und ausgewählte Alarmplätze und liefert einen fortsetzbaren Auftrag; andere Vorlagen werden sofort angewendet. Wiederholte normalisierte Anfragen liefern den vorhandenen Monitor.

Auf dieser Seite

Zugriff und Rechte

Wendet eine Vorlage atomar innerhalb der Kontogrenzen an. Server/NAS v2 reserviert Monitor, Reihen und ausgewählte Alarmplätze und liefert einen fortsetzbaren Auftrag; andere Vorlagen werden sofort angewendet. Wiederholte normalisierte Anfragen liefern den vorhandenen Monitor.

Browsersitzung: Cookie __Host-mb_session.

Maschinen-Verwaltungszugang in Authorization: Bearer. Beachten Sie die von der Operation benötigten Berechtigungen (Scopes).

Senden Sie bei einer Änderung mit Browsersitzung das aktuelle CSRF-Token in X-CSRF-Token zusammen mit dem Same-Site-Cookie. OAuth-Zustimmung verwendet ihr dokumentiertes Formularfeld.

Parameter und Header

FeldPositionTyp und GrenzenErforderlichBedeutung
OriginHeaderstring; {"format":"uri"}NeinMuss, falls vorhanden, dem kanonischen HTTPS-Origin entsprechen. Sec-Fetch-Site cross-site wird abgewiesen.
X-CSRF-TokenHeaderstringNeinWert des Browser-CSRF-Cookies. Bei einem zulässigen Maschinen-Verwaltungszugang nicht erforderlich.

Anfragekörper

FeldTyp und GrenzenErforderlichBedeutung
$TemplateRequestJa—
$.activate_alarmsarray<TemplateAlarmActivation>; {"maxItems":200}NeinOptional; nur ausdrücklich gewählte Vorschläge mit vollständigen Bedingungen werden atomar angelegt. Der Vorschlag run überwacht fehlgeschlagene, abgebrochene, überlange und ausgebliebene Läufe gemeinsam.
$.activate_alarms[]TemplateAlarmActivationJa—
$.activate_alarms[].clearAlarmConditionNein—
$.activate_alarms[].clear.operatorstring; {"enum":["gt","lt","eq","ne","outside","inside"]}Ja—
$.activate_alarms[].clear.valuenumberJa—
$.activate_alarms[].clear.value_highnumberNeinPflicht bei inside und outside; muss größer als value sein
$.activate_alarms[].clear (allOf 1)JSONNein—
$.activate_alarms[].clear_duration_secondsinteger; {"maximum":86400,"minimum":0}Nein—
$.activate_alarms[].kindstring; {"enum":["numeric","state","no_data","heartbeat","run"]}JaMuss genau einmal zu einem Vorschlag der gewählten Vorlagenversion passen.
$.activate_alarms[].namestring; {"maxLength":128,"minLength":1}JaLesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze.
$.activate_alarms[].no_data_secondsinteger; {"maximum":604800,"minimum":30}Nein—
$.activate_alarms[].severitystring; {"enum":["info","warning","critical"]}JaSchweregrad aus dem angegebenen Wertebereich.
$.activate_alarms[].state_clear_samplesinteger; {"default":2,"maximum":2,"minimum":1}NeinAnzahl verschiedener gültiger aufeinanderfolgender Prüfungen für diesen Zustandswechsel.
$.activate_alarms[].state_trigger_samplesinteger; {"default":2,"maximum":2,"minimum":1}NeinAnzahl verschiedener gültiger aufeinanderfolgender Prüfungen für diesen Zustandswechsel.
$.activate_alarms[].suggestion_idstring; {"maxLength":256}JaStabile Vorschlagskennung der aktuellen Vorlage oder des Serverprofils; mehrere Regeln können dieselbe Art besitzen.
$.activate_alarms[].target_statestring; {"maxLength":128}Nein—
$.activate_alarms[].triggerAlarmConditionNein—
$.activate_alarms[].trigger.operatorstring; {"enum":["gt","lt","eq","ne","outside","inside"]}Ja—
$.activate_alarms[].trigger.valuenumberJa—
$.activate_alarms[].trigger.value_highnumberNeinPflicht bei inside und outside; muss größer als value sein
$.activate_alarms[].trigger (allOf 1)JSONNein—
$.activate_alarms[].trigger_duration_secondsinteger; {"maximum":86400,"minimum":0}Nein—
$.configobjectNeinFür website_api sind url und ein bis fünf autorisierte location_ids erforderlich; für backup_cron sind cron und timezone erforderlich. HTTP-Konfiguration verwendet HTTPMonitorConfig.
$.external_idstring; {"maxLength":128,"minLength":1}JaStabile eigene Kennung für idempotente Wiederholung; Änderungen an der ursprünglichen Anfrage ergeben 409.
$.namestring; {"maxLength":128,"minLength":1}JaLesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze.
$.pausedboolean; {"default":false}NeinOb automatische Monitorarbeit pausiert ist. Vorhandene Messdaten und Historien bleiben erhalten.
$.server_profileServerProfileRequestNein—
$.server_profile.componentsarray<object>; {"maxItems":200} | nullNeinErkannte oder ausdrücklich ausgewählte Serverkomponenten.
$.server_profile.components (anyOf 1)array<object>; {"maxItems":200}Nein—
$.server_profile.components (anyOf 1)[]objectJa—
$.server_profile.components (anyOf 1)[].addressstringNein—
$.server_profile.components (anyOf 1)[].familystringNein—
$.server_profile.components (anyOf 1)[].idstringJaUUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf.
$.server_profile.components (anyOf 1)[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$.server_profile.components (anyOf 1)[].labelstring; {"maxLength":128,"minLength":1}JaAnzeigename der Komponente.
$.server_profile.components (anyOf 1)[].local_refstringNein—
$.server_profile.components (anyOf 1)[].namestringNeinLesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze.
$.server_profile.components (anyOf 1)[].pathstring; {"maxLength":1024}Nein—
$.server_profile.components (anyOf 1)[].portintegerNein—
$.server_profile.components (anyOf 1)[].projectstringNein—
$.server_profile.components (anyOf 1)[].protocolstringNein—
$.server_profile.components (anyOf 1)[].text_languagesobjectNein—
$.server_profile.components (anyOf 1)[].timeout_secondsintegerNein—
$.server_profile.components (anyOf 1)[].translationsobject; {"additionalProperties":false}Nein—
$.server_profile.components (anyOf 1)[].translations.deobjectNein—
$.server_profile.components (anyOf 1)[].translations.enobjectNein—
$.server_profile.components (anyOf 1)[].transportstringNein—
$.server_profile.components (anyOf 1)[].filesystem_identitystring; {"maxLength":256}NeinVom Agenten gemeldete Volumeidentität. Unverändert beibehalten, damit ein Ersatzvolume nicht die Historie eines anderen Volumes fortsetzt.
$.server_profile.components (anyOf 1)[].disk_identitystring; {"maxLength":256}Nein—
$.server_profile.components (anyOf 2)nullNein—
$.server_profile.selectionsarray<object>; {"maxItems":200} | nullNeinGewählte Komponenten-/Parameterpaare mit Abtastintervallen.
$.server_profile.selections (anyOf 1)array<object>; {"maxItems":200}Nein—
$.server_profile.selections (anyOf 1)[]objectJa—
$.server_profile.selections (anyOf 1)[].component_idstringJaStabile Kennung der gewählten oder erkannten Komponente.
$.server_profile.selections (anyOf 1)[].interval_secondsinteger; {"maximum":86400,"minimum":0}NeinAbtast- oder Prüfintervall in Sekunden innerhalb der angegebenen Grenzen.
$.server_profile.selections (anyOf 1)[].parameter_keystringJaStabile Parameterkennung aus dem Serverkatalog.
$.server_profile.selections (anyOf 2)nullNein—
$.server_profile.versionJSON; {"const":2}Ja—
$.server_profile.overviewobject; {"additionalProperties":false}NeinAusdrückliche Ziele für die Serverübersicht mit sechs Diagrammen; wählen Sie alle benötigten Messwerte aus.
$.server_profile.overview.system_idstring; {"maxLength":128}Ja—
$.server_profile.overview.filesystem_idstring; {"maxLength":128}Ja—
$.server_profile.overview.disk_idstring; {"maxLength":128}Ja—
$.server_profile.overview.network_idstring; {"maxLength":128}Ja—
$.server_profile.filesystem_discoveryobject; {"additionalProperties":false}NeinOptionale Erkennung lokaler Dateisysteme mit einem Grundintervall von mindestens 10 Sekunden. Neue Server/NAS-Einrichtungen aktivieren sie. Bestehende Profile benötigen eine ausdrückliche Aktivierung. Manuell deaktivierte Messreihen bleiben erhalten.
$.server_profile.filesystem_discovery.modestring; {"enum":["off","local"]}Ja—
$.server_profile.filesystem_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Ja—
$.server_profile.system_discoveryobject; {"additionalProperties":false}Nein—
$.server_profile.system_discovery.modestring; {"enum":["off","local"]}Ja—
$.server_profile.system_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Ja—
$.server_profile.global_interval_secondsinteger; {"minimum":1,"maximum":86400}NeinAusdrückliche globale Intervallauswahl. Jede Quelle behält ihr Plattformminimum; einzelne schnelle Reihen gelten nicht als globale Auswahl.
$.template_idstring; {"enum":["server_nas","website_api","backup_cron","workflow_agent","sensor_energy","application_kpi","custom_data","tcp_port","udp_reply","dns_records","tls_certificate","host_ping","service_health","browser_journey"]}Ja—
$.versioninteger; {"enum":[1,2]}JaServer/NAS verwendet Version 2; alle anderen Vorlagen verwenden Version 1.
$.workspace_idstring; {"format":"uuid"}JaUUID des zugehörigen Arbeitsbereichs. Zugriff wird gegen das angemeldete Konto geprüft.
$ (allOf 1)JSONNein—
$ (allOf 2)JSONNein—

Antworten

HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/json

FeldTyp und GrenzenErforderlichBedeutung
$objectJa—
$.alarm_idsobjectNein—
$.alarm_suggestionsarray<object>Nein—
$.alarm_suggestions[]objectJa—
$.alarm_suggestions[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$.alarm_suggestions[].series_keystringNein—
$.alarm_suggestions[].summarystringJa—
$.alarm_suggestions[].summary_keystringJa—
$.alarms_activatedbooleanNein—
$.monitor_idstringNeinUUID des betroffenen Monitors.
$.replayedbooleanNein—
$.series_idsobjectNein—
$.template_idstringNein—
$.template_versionintegerNein—
$.widget_suggestionsarray<object>Nein—
$.widget_suggestions[]objectJa—
$.widget_suggestions[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$.widget_suggestions[].series_idstringJaUUID der Messreihe des freigegebenen Geräts.
$.widget_suggestions[].titlestringJaKurze lesbare Bezeichnung der Antwort oder des Widgets.
$.widget_suggestions[].title_keystringJa—
$.config_revisioninteger; {"minimum":1}Nein—
json
{}
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/json

FeldTyp und GrenzenErforderlichBedeutung
$objectJa—
$.alarm_idsobjectNein—
$.alarm_suggestionsarray<object>Nein—
$.alarm_suggestions[]objectJa—
$.alarm_suggestions[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$.alarm_suggestions[].series_keystringNein—
$.alarm_suggestions[].summarystringJa—
$.alarm_suggestions[].summary_keystringJa—
$.alarms_activatedbooleanNein—
$.monitor_idstringNeinUUID des betroffenen Monitors.
$.replayedbooleanNein—
$.series_idsobjectNein—
$.template_idstringNein—
$.template_versionintegerNein—
$.widget_suggestionsarray<object>Nein—
$.widget_suggestions[]objectJa—
$.widget_suggestions[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$.widget_suggestions[].series_idstringJaUUID der Messreihe des freigegebenen Geräts.
$.widget_suggestions[].titlestringJaKurze lesbare Bezeichnung der Antwort oder des Widgets.
$.widget_suggestions[].title_keystringJa—
$.pending_alarmsarray<string; {"maxLength":128}>Nein—
$.pending_alarms[]string; {"maxLength":128}Ja—
$.config_revisioninteger; {"minimum":1}Nein—
json
{}
Stabile Fehlercodes
invalid_credential
unauthorized
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 401,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
csrf
insufficient_scope
invalid_origin
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 403,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
not_found
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 404,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
external_id_conflict
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 409,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
invalid_payload
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 422,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
quota_exceeded
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 429,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
feature_unavailable
unavailable
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 503,
  "title": "Demo error",
  "type": "about:blank"
}

Wiederholungen und asynchrone Aufträge

Behalten Sie die dokumentierten Kennungen bei Wiederholungen. Ersetzen Sie sie nach einer unklaren Antwort nicht durch neue Kennungen, die eine weitere Ressource oder Messung erzeugen könnten.

Anfragebeispiele

Ersetzen Sie Demokennungen, Zeitstempel und Platzhalter durch eigene Werte. Behalten Sie bei Wiederholungen Kennungen, Zeit und Inhalt bei. Diese Beispiele führen auf der Seite keine Anfragen aus.

Halten Sie Anmeldelinks, Codes, Cookies und Schlüssel privat. Schreiben Sie sie nicht in Logs und teilen Sie sie nicht in Hilfeanfragen.

shell
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
  --request POST \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  --header "Content-Type: application/json" \
  --data-binary '{"external_id":"demo","name":"demo","template_id":"server_nas","version":2,"workspace_id":"00000000-0000-4000-8000-000000000001"}' \
  "https://metribeacon.com/api/v1/templates/apply"
python
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError

headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
headers["Content-Type"] = "application/json"
request = Request("https://metribeacon.com/api/v1/templates/apply", data="{\"external_id\":\"demo\",\"name\":\"demo\",\"template_id\":\"server_nas\",\"version\":1,\"workspace_id\":\"00000000-0000-4000-8000-000000000001\"}".encode("utf-8"), headers=headers, method="POST")
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, request, fp, code, message, headers, target):
        return None

opener = build_opener(NoRedirect())
try:
    with opener.open(request, timeout=10) as response:
        print(response.status)
except HTTPError as error:
    print(error.code)
    error.close()
javascript
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";

const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
headers["Content-Type"] = "application/json";
const response = await fetch("https://metribeacon.com/api/v1/templates/apply", {
  method: "POST", headers, redirect: "manual",
  signal: AbortSignal.timeout(10000), body: "{\"external_id\":\"demo\",\"name\":\"demo\",\"template_id\":\"server_nas\",\"version\":1,\"workspace_id\":\"00000000-0000-4000-8000-000000000001\"}",
});
console.log(response.status);
await response.body?.cancel();
go
package main

import (
  "fmt"
  "net/http"
  "time"
  "encoding/json"
  "os"
  "path/filepath"
  "strings"
)

func main() {
  home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
  raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
  var headers map[string]string
  if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
  request, err := http.NewRequest("POST", "https://metribeacon.com/api/v1/templates/apply", strings.NewReader("{\"external_id\":\"demo\",\"name\":\"demo\",\"template_id\":\"server_nas\",\"version\":1,\"workspace_id\":\"00000000-0000-4000-8000-000000000001\"}"))
  if err != nil { panic("request failed; credentials and response omitted") }
  for name, value := range headers { request.Header.Set(name, value) }
  request.Header.Set("Content-Type", "application/json")
  client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
  response, err := client.Do(request)
  if err != nil { panic("request failed; credentials and response omitted") }
  defer response.Body.Close()
  fmt.Println(response.StatusCode)
}