Dokumentation / API · Alarme / Interne Vorfallnotiz hinzufügen POST Interne Vorfallnotiz hinzufügen/api/v1/alarms/incidents/{id}/notes
Editoren können mit einer Vorgangs-UUID Textnotizen bis 4 KiB anlegen. Limits je Owner-Konto: 10 pro Minute, 100 je UTC-Tag und 1.000 je Vorfall einschließlich gelöschter Notizen. Dieselbe UUID liefert dieselbe Notiz. Notizen werden nie automatisch veröffentlicht oder versendet.
Auf dieser Seite Zugriff und Rechte Parameter und Header Anfragekörper Antworten Wiederholungen und asynchrone Aufträge Anfragebeispiele Verwandte Anleitungen Editoren können mit einer Vorgangs-UUID Textnotizen bis 4 KiB anlegen. Limits je Owner-Konto: 10 pro Minute, 100 je UTC-Tag und 1.000 je Vorfall einschließlich gelöschter Notizen. Dieselbe UUID liefert dieselbe Notiz. Notizen werden nie automatisch veröffentlicht oder versendet.
Browsersitzung: Cookie __Host-mb_session.
Maschinen-Verwaltungszugang in Authorization: Bearer. Beachten Sie die von der Operation benötigten Berechtigungen (Scopes).
Benötigte Maschinenberechtigungen (Scopes): config:write 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.
Feld Position Typ und Grenzen Erforderlich Bedeutung id Pfad string; {"format":"uuid"} Ja Ressourcen-UUID aus dem Pfad. Sie muss existieren und für die handelnde Identität zugänglich sein.
Feld Typ und Grenzen Erforderlich Bedeutung $ object Ja — $.body string Ja — $.operation_id string Ja —
422 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes incident_note_limit invalid_incident invalid_input
Header Typ und Grenzen Bedeutung Cache-Control string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. Content-Language string; {"enum":["en","de"]} Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. Referrer-Policy JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. Vary string Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. X-Content-Type-Options JSON; {"const":"nosniff"} Der Browser muss den angegebenen Inhaltstyp verwenden. X-Frame-Options JSON; {"const":"DENY"} Die Antwort darf nicht in einem Frame eingebettet werden. X-Request-ID string Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.
application/problem+json
Feld Typ und Grenzen Erforderlich Bedeutung $ Problem Ja — $.code string Ja Stabiler maschinenlesbarer Fehlercode $.detail string Ja Kurze lokalisierte Erklärung ohne interne Fehlerdaten $.instance string Ja Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource $.message string Ja Vorübergehend für bestehende Clients gleich detail $.message_key string Ja Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage $.message_params object; {"additionalProperties":true} Ja Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML $.request_id string; {"pattern":"^[0-9a-f]{32}$"} Ja Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. $.status integer; {"maximum":599,"minimum":400} Ja — $.title string Ja Lokalisierte HTTP-Statusbezeichnung $.type string; {"const":"about:blank"} Ja —
json Beispiel kopieren
{
"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"
} 503 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes unavailable
Header Typ und Grenzen Bedeutung Cache-Control string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. Content-Language string; {"enum":["en","de"]} Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. Referrer-Policy JSON; {"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-After string; {"pattern":"^[0-9]+$"} Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. Vary string Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. X-Content-Type-Options JSON; {"const":"nosniff"} Der Browser muss den angegebenen Inhaltstyp verwenden. X-Frame-Options JSON; {"const":"DENY"} Die Antwort darf nicht in einem Frame eingebettet werden. X-Request-ID string Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.
application/problem+json
Feld Typ und Grenzen Erforderlich Bedeutung $ Problem Ja — $.code string Ja Stabiler maschinenlesbarer Fehlercode $.detail string Ja Kurze lokalisierte Erklärung ohne interne Fehlerdaten $.instance string Ja Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource $.message string Ja Vorübergehend für bestehende Clients gleich detail $.message_key string Ja Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage $.message_params object; {"additionalProperties":true} Ja Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML $.request_id string; {"pattern":"^[0-9a-f]{32}$"} Ja Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. $.status integer; {"maximum":599,"minimum":400} Ja — $.title string Ja Lokalisierte HTTP-Statusbezeichnung $.type string; {"const":"about:blank"} Ja —
json Beispiel kopieren
{
"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"
} 404 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes not_found
Header Typ und Grenzen Bedeutung Cache-Control string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. Content-Language string; {"enum":["en","de"]} Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. Referrer-Policy JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. Vary string Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. X-Content-Type-Options JSON; {"const":"nosniff"} Der Browser muss den angegebenen Inhaltstyp verwenden. X-Frame-Options JSON; {"const":"DENY"} Die Antwort darf nicht in einem Frame eingebettet werden. X-Request-ID string Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.
application/problem+json
Feld Typ und Grenzen Erforderlich Bedeutung $ Problem Ja — $.code string Ja Stabiler maschinenlesbarer Fehlercode $.detail string Ja Kurze lokalisierte Erklärung ohne interne Fehlerdaten $.instance string Ja Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource $.message string Ja Vorübergehend für bestehende Clients gleich detail $.message_key string Ja Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage $.message_params object; {"additionalProperties":true} Ja Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML $.request_id string; {"pattern":"^[0-9a-f]{32}$"} Ja Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. $.status integer; {"maximum":599,"minimum":400} Ja — $.title string Ja Lokalisierte HTTP-Statusbezeichnung $.type string; {"const":"about:blank"} Ja —
json Beispiel kopieren
{
"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"
} 403 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes forbidden insufficient_scope invalid_origin csrf
Header Typ und Grenzen Bedeutung Cache-Control string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. Content-Language string; {"enum":["en","de"]} Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. Referrer-Policy JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. Vary string Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. X-Content-Type-Options JSON; {"const":"nosniff"} Der Browser muss den angegebenen Inhaltstyp verwenden. X-Frame-Options JSON; {"const":"DENY"} Die Antwort darf nicht in einem Frame eingebettet werden. X-Request-ID string Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.
application/problem+json
Feld Typ und Grenzen Erforderlich Bedeutung $ Problem Ja — $.code string Ja Stabiler maschinenlesbarer Fehlercode $.detail string Ja Kurze lokalisierte Erklärung ohne interne Fehlerdaten $.instance string Ja Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource $.message string Ja Vorübergehend für bestehende Clients gleich detail $.message_key string Ja Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage $.message_params object; {"additionalProperties":true} Ja Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML $.request_id string; {"pattern":"^[0-9a-f]{32}$"} Ja Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. $.status integer; {"maximum":599,"minimum":400} Ja — $.title string Ja Lokalisierte HTTP-Statusbezeichnung $.type string; {"const":"about:blank"} Ja —
json Beispiel kopieren
{
"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"
} 409 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes idempotency_conflict invalid_incident
Header Typ und Grenzen Bedeutung Cache-Control string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. Content-Language string; {"enum":["en","de"]} Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. Referrer-Policy JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. Vary string Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. X-Content-Type-Options JSON; {"const":"nosniff"} Der Browser muss den angegebenen Inhaltstyp verwenden. X-Frame-Options JSON; {"const":"DENY"} Die Antwort darf nicht in einem Frame eingebettet werden. X-Request-ID string Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.
application/problem+json
Feld Typ und Grenzen Erforderlich Bedeutung $ Problem Ja — $.code string Ja Stabiler maschinenlesbarer Fehlercode $.detail string Ja Kurze lokalisierte Erklärung ohne interne Fehlerdaten $.instance string Ja Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource $.message string Ja Vorübergehend für bestehende Clients gleich detail $.message_key string Ja Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage $.message_params object; {"additionalProperties":true} Ja Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML $.request_id string; {"pattern":"^[0-9a-f]{32}$"} Ja Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. $.status integer; {"maximum":599,"minimum":400} Ja — $.title string Ja Lokalisierte HTTP-Statusbezeichnung $.type string; {"const":"about:blank"} Ja —
json Beispiel kopieren
{
"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"
} 429 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes incident_note_limit invalid_incident
Header Typ und Grenzen Bedeutung Cache-Control string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. Content-Language string; {"enum":["en","de"]} Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. Referrer-Policy JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. Vary string Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. X-Content-Type-Options JSON; {"const":"nosniff"} Der Browser muss den angegebenen Inhaltstyp verwenden. X-Frame-Options JSON; {"const":"DENY"} Die Antwort darf nicht in einem Frame eingebettet werden. X-Request-ID string Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.
application/problem+json
Feld Typ und Grenzen Erforderlich Bedeutung $ Problem Ja — $.code string Ja Stabiler maschinenlesbarer Fehlercode $.detail string Ja Kurze lokalisierte Erklärung ohne interne Fehlerdaten $.instance string Ja Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource $.message string Ja Vorübergehend für bestehende Clients gleich detail $.message_key string Ja Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage $.message_params object; {"additionalProperties":true} Ja Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML $.request_id string; {"pattern":"^[0-9a-f]{32}$"} Ja Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. $.status integer; {"maximum":599,"minimum":400} Ja — $.title string Ja Lokalisierte HTTP-Statusbezeichnung $.type string; {"const":"about:blank"} Ja —
json Beispiel kopieren
{
"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"
} 200 · Aktueller Stand der Vorfallzusammenarbeit. application/json
Feld Typ und Grenzen Erforderlich Bedeutung $ object Ja —
201 · Aktueller Stand der Vorfallzusammenarbeit. application/json
Feld Typ und Grenzen Erforderlich Bedeutung $ object Ja —
Für diese Änderung gibt es keine allgemeine Wiederholungsgarantie. Prüfen Sie bei unklarer Antwort den betroffenen Eintrag, bevor Sie es erneut versuchen. Beachten Sie Wartezeiten aus Retry-After und fordern Sie abgelaufene Anmelde- oder Aktionscodes neu an.
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 Beispiel kopieren
curl --request POST --cookie '__Host-mb_session=SESSION; __Host-mb_csrf=CSRF' --header 'X-CSRF-Token: CSRF' --header 'Content-Type: application/json' --data '{"body":"Investigating the service.","operation_id":"33333333-3333-4333-8333-333333333333"}' 'https://metribeacon.com/api/v1/alarms/incidents/11111111-1111-4111-8111-111111111111/notes' python Beispiel kopieren
import requests
response=requests.request( 'POST' , 'https://metribeacon.com/api/v1/alarms/incidents/11111111-1111-4111-8111-111111111111/notes' ,cookies={ "__Host-mb_session" : "SESSION" , "__Host-mb_csrf" : "CSRF" },headers={ "X-CSRF-Token" : "CSRF" },json={ 'body' : 'Investigating the service.' , 'operation_id' : '33333333-3333-4333-8333-333333333333' })
response.raise_for_status() javascript Beispiel kopieren
const response=await fetch( "https://metribeacon.com/api/v1/alarms/incidents/11111111-1111-4111-8111-111111111111/notes" ,{method: "POST" ,credentials: "same-origin" ,headers:{ "Content-Type" : "application/json" , "X-CSRF-Token" :csrf},body:JSON.stringify({ "body" : "Investigating the service." , "operation_id" : "33333333-3333-4333-8333-333333333333" })});
if (!response.ok)throw new Error(String(response.status)); go Beispiel kopieren
package main
import ( "net/http" ; "strings" ; "time" )
func main(){req,err:=http.NewRequest( "POST" , "https://metribeacon.com/api/v1/alarms/incidents/11111111-1111-4111-8111-111111111111/notes" ,strings.NewReader(`{ "body" : "Investigating the service." , "operation_id" : "33333333-3333-4333-8333-333333333333" }`)); if err!=nil{panic( "request failed" )};req.AddCookie(&http.Cookie{Name: "__Host-mb_session" ,Value: "SESSION" });req.AddCookie(&http.Cookie{Name: "__Host-mb_csrf" ,Value: "CSRF" });req.Header.Set( "X-CSRF-Token" , "CSRF" );req.Header.Set( "Content-Type" , "application/json" );c:=http.Client{Timeout:10*time.Second};res,err:=c.Do(req); if err!=nil{panic( "request failed" )}; defer res.Body.Close()}