Skip to main content

Update Pod Incident Summary

PUT 
/api/support/agent/pod-incidents/:id

Sets or clears the summary of an outage. Every tenant hosted on the affected server sees the summary next to the outage in their Support Insights report, so it is checked against the redaction rules (see Get Insights Redaction Rules) — a match is refused with 422 naming the rule, never quoting the matched text.

Required scope: support:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request body

  • summary (string or null, required, max 500 characters) — the text tenants see. Send null or an empty string to clear it; surrounding whitespace is trimmed

Response fields (data)

  • id (integer)
  • pod (string) — the server the outage was on (staff-only; tenants never see it)
  • started_at / ended_at (ISO-8601) — ended_at is null while the outage is still open
  • duration_minutes (integer, nullable)
  • components (string[]) — which of web, app, database, cache were down
  • source (string) — derived (detected from failed health checks) or manual (entered by staff)
  • summary (string, nullable)
  • updated_at (ISO-8601)

Authentication: Bearer token with the support:write scope, or an authenticated session, from a caller with an active support role. No tenant context.

Request​

Responses​

OK

Response Headers
    Content-Type