Add a note or status update
POST
/organizations/{org_id}/incidents/{incident_id}/note
const url = 'https://api.perstat.io/organizations/example/incidents/example/note';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"body":"example","state":"example","visibility":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.perstat.io/organizations/example/incidents/example/note \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "body": "example", "state": "example", "visibility": "example" }'Appends a timeline note to the incident and optionally sets the lifecycle state (investigating, identified, or monitoring). Notes are internal by default; only an explicit public visibility makes them appear on status pages. An empty body without a state change returns 400.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”org_id
required
string
incident_id
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
body
string
state
string | null
visibility
"public" → das Update erscheint auf der öffentlichen Status-Seite.
Alles andere (None/“”) bleibt intern (sicherer Default, kein Leak).
string | null
Examplegenerated
{ "body": "example", "state": "example", "visibility": "example"}Responses
Section titled “Responses”Media typeapplication/json
object
acknowledged_at_unix
integer | null format: int64
acknowledged_by_email
string | null
alarm_held_by_name
string | null
alarm_held_until_unix
Abhaengige Alarme: bis wann die Alarmkette zurueckgehalten wird (Unix-Sekunden), und WER sie haelt. Beides gehoert nach aussen , ein zurueckgehaltener Alarm, den man nicht sehen kann, ist von einem verschluckten nicht zu unterscheiden.
integer | null format: int64
auto_resolved
required
boolean
cause
required
string
check_kind
string | null
commander_email
string | null
down_regions
required
Array<string>
evidence
One of:
null
Immutable trigger snapshot; null for legacy/manual/simulated incidents.
object
actual_summary
string | null
check_kind
required
string
checks
required
Array<object>
object
cause_layer
Target attribution such as target_dns or target_app.
string | null
check_id
required
string
checked_at_unix
required
integer format: int64
detail
string | null
latency_ms
integer | null format: int32
region
string | null
response_code
integer | null format: int32
status
required
string
confirmation_state
string | null
confirmed_outage_since_unix
integer | null format: int64
consecutive_failures_observed
integer | null format: int32
consecutive_failures_required
required
integer format: int32
expected_regions
integer | null format: int32
expected_summary
string | null
failed_regions
required
integer
failure_class
string | null
findings
Array<object>
object
actual_summary
required
string
expected_summary
required
string
failure_class
required
string
latest_checked_at_unix
required
integer format: int64
occurrence_count
required
integer
regions
required
Array<string>
first_failure_at_unix
integer | null format: int64
minimum_confirmed_outage_seconds
integer | null format: int32
monitor_id
required
string
monitor_name
required
string
project_id
required
string
project_name
required
Project is the stored product context; Perstat has no environment field.
string
reason
required
string
reporting_regions
required
integer format: int32
required_regions
required
integer format: int32
triggered_at_unix
required
integer format: int64
version
required
integer format: int32
failure_phase_started_at_unix
First quorum-confirmed failure of the uninterrupted measurement phase.
integer | null format: int64
id
required
string
lifecycle_state
required
string
monitor_id
required
string
monitor_name
string | null
project_id
Stable project public id for monitor drill-down, including legacy or manual incidents without an immutable evidence snapshot.
string | null
project_name
string | null
region_count
required
integer format: int32
resolved_at_unix
integer | null format: int64
severity
required
string
severity_level
string | null
started_at_unix
required
integer format: int64
status
required
string
summary
required
string
Examplegenerated
{ "acknowledged_at_unix": 1, "acknowledged_by_email": "example", "alarm_held_by_name": "example", "alarm_held_until_unix": 1, "auto_resolved": true, "cause": "example", "check_kind": "example", "commander_email": "example", "down_regions": [ "example" ], "evidence": { "actual_summary": "example", "check_kind": "example", "checks": [ { "cause_layer": "example", "check_id": "example", "checked_at_unix": 1, "detail": "example", "latency_ms": 1, "region": "example", "response_code": 1, "status": "example" } ], "confirmation_state": "example", "confirmed_outage_since_unix": 1, "consecutive_failures_observed": 1, "consecutive_failures_required": 1, "expected_regions": 1, "expected_summary": "example", "failed_regions": 1, "failure_class": "example", "findings": [ { "actual_summary": "example", "expected_summary": "example", "failure_class": "example", "latest_checked_at_unix": 1, "occurrence_count": 1, "regions": [ "example" ] } ], "first_failure_at_unix": 1, "minimum_confirmed_outage_seconds": 1, "monitor_id": "example", "monitor_name": "example", "project_id": "example", "project_name": "example", "reason": "example", "reporting_regions": 1, "required_regions": 1, "triggered_at_unix": 1, "version": 1 }, "failure_phase_started_at_unix": 1, "id": "example", "lifecycle_state": "example", "monitor_id": "example", "monitor_name": "example", "project_id": "example", "project_name": "example", "region_count": 1, "resolved_at_unix": 1, "severity": "example", "severity_level": "example", "started_at_unix": 1, "status": "example", "summary": "example"}