monitoring.incidents.create

Post an incident; the page’s confirmed subscribers are emailed and webhooks called

POST /monitoring/api/status-pages/{id}/incidentsIAM monitoring:CreateIncidentChanges state

While open, an incident makes its components at least as bad as its impact says (minor → degraded, major → partial outage, critical → major outage). Bodies are plain text.

Request syntax

POST /monitoring/api/status-pages/{id}/incidents
{
  "title": "string",
  "impact": "enum",
  "status": "enum",
  "body": "string",
  "componentIds": "array of string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • titleRequired

    string

    One line, up to 200 characters

  • impactRequired

    enum

    none, minor (degraded), major (partial outage), critical (major outage)

    One of: none, minor, major, critical

  • statusOptional

    enum

    investigating by default; resolved posts it already closed

    One of: investigating, identified, monitoring, resolved

  • bodyRequired

    string

    The first update, plain text, up to 5000 characters

  • componentIdsOptional

    array of string

    Components it affects, each on this page (400 otherwise); none by default

    Constraints: uuid

Response

201 with the incident as list describes it, plus notified: what was sent to subscribers (e.g. "emailed 3, webhooks 1"). 400 for a component not on this page; 404 when the organization has no such page.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow monitoring:CreateIncident on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud monitoring incidents create id --title example --impact none --body example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_monitoring_incidents_create.