EvoHub Docs Sign in

Status API › Incidents

Edit an incident

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

PATCH/api/v1/pages/{pageID}/incidents/{id}

Edits the title, impact or status; a field left out keeps its value. This adds no timeline entry and mails nobody: post an update for that.

Permission (API-key scope): status:incident:write.

Authorization

Any one of:

Parameters

Path parameters

  • pageID string (uuid) required
    The status page's id (a UUID).
    Example: 3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42
  • id string (uuid) required
    The incident's, maintenance window's or subscriber's id (a UUID).

Request body required

Content type: application/json

Type: IncidentPatch

A field left out keeps its value.

  • title string
  • impact IncidentImpact
    One of: none minor major critical
  • status IncidentStatus
    One of: investigating identified monitoring resolved

Responses

200

The incident.

Content type: application/json

Type: object

  • data Incident required
    Show Incident properties
    • id string (uuid) required
    • org_id string required
    • page_id string (uuid) required
    • title string required
    • impact IncidentImpact required
      One of: none minor major critical
    • status IncidentStatus required
      One of: investigating identified monitoring resolved
    • started_at string (date-time) required
    • resolved_at string (date-time)
    • created_at string (date-time) required
      When the page got it.
    • updated_at string (date-time) required
    • postmortem_body string
      Markdown; absent when none is written.
    • postmortem_published_at string (date-time)
      Set while the postmortem shows on the public page.
    • backfilled boolean required
      Written after the fact with its own past times; it mailed no subscriber.
    • managed_in ManagedIn required
      One of: oncall status_page
    • affected_component_ids array of string (uuid) required
    • updates array of IncidentUpdate required
      The timeline.
      Show IncidentUpdate properties
      • id string (uuid)
      • incident_id string (uuid)
      • status IncidentStatus
        One of: investigating identified monitoring resolved
      • body string
      • created_at string (date-time)
  • success boolean required
    Value: true

400

A field is missing or invalid (VALIDATION_ERROR); the message names it, or the body is not valid (INVALID_BODY).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

401

No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

403

The key lacks the scope this endpoint needs (FORBIDDEN).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

404

No such page or incident, or one on another page (NOT_FOUND).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

429

Too many requests (RATE_LIMITED). Wait Retry-After seconds.

Headers

  • Retry-After integer
    Seconds to wait.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

500

Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

Example request

curl -X PATCH 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/incidents/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "impact": "minor"
}'

Last updated