Responses

• 200 application/json

  Status summary retrieved successfully

  Hide response attributes Show response attributes object

  • page object Required
    Hide page attributes Show page attributes object

    • id string Required

      Unique identifier for the page

    • name string Required

      Name of the status page

    • url string(uri) Required

      URL of the status page

    • updated_at string(date-time) Required

      Timestamp when the page was last updated (ISO 8601)

  • components array[object] Required

    List of component statuses

    Hide components attributes Show components attributes object

    • created_at string(date-time) Required

      Timestamp when the component was created (ISO 8601)

    • description string | null

      Description of the component

    • id string Required

      Unique identifier for the component

    • name string Required

      Name of the component

    • only_show_if_degraded boolean Required

      Whether to show only if degraded

    • page_id string Required

      Unique page identifier

    • position integer Required

      Display position

    • status string Required

      Current status of the component

      Values are operational, degraded_performance, partial_outage, or major_outage.

    • updated_at string(date-time) Required

      Timestamp when the component was last updated (ISO 8601)

  • incidents array[object] Required

    List of unresolved incidents

    Hide incidents attributes Show incidents attributes object

    • created_at string(date-time) Required

      Timestamp when the incident was created (ISO 8601)

    • id string Required

      Unique identifier for the incident

    • impact string Required

      Impact level

      Values are none, minor, major, critical, or maintenance.

    • incident_updates array[object] Required

      List of updates for the incident

      Hide incident_updates attributes Show incident_updates attributes object

      • body string Required

        Update message

      • created_at string(date-time) Required

        Timestamp when the update was created (ISO 8601)

      • display_at string(date-time) | null Required

        Timestamp for display (ISO 8601)

      • id string Required

        Unique update identifier

      • incident_id string Required

        Unique incident identifier

      • status string Required

        Update status

        Values are investigating, identified, monitoring, resolved, postmortem, scheduled, in_progress, verifying, or completed.

      • updated_at string(date-time) Required

        Timestamp when the update was last modified (ISO 8601)

    • monitoring_at string(date-time) | null

      Timestamp when monitoring started (ISO 8601)

    • name string Required

      Incident name

    • page_id string Required

      Unique page identifier

    • postmortem_body string | null

      Postmortem analysis body

    • postmortem_body_last_updated_at string(date-time) | null

      Timestamp when postmortem was last updated (ISO 8601)

    • postmortem_ignored boolean

      Whether postmortem is ignored

    • postmortem_notified_subscribers boolean

      Whether subscribers were notified of postmortem

    • postmortem_published_at string(date-time) | null

      Timestamp when postmortem was published (ISO 8601)

    • resolved_at string(date-time) | null

      Timestamp when the incident was resolved (ISO 8601)

    • scheduled_for string(date-time) | null

      Scheduled start time (for maintenances) (ISO 8601)

    • scheduled_remind_prior boolean

      Whether to send reminders prior to the scheduled time

    • scheduled_reminded_at string(date-time) | null

      Timestamp when reminders were sent (ISO 8601)

    • scheduled_until string(date-time) | null

      Scheduled end time (ISO 8601)

    • shortlink string(uri) Required

      Short URL for the incident

    • status string Required

      Current incident status

      Values are investigating, identified, monitoring, resolved, or postmortem.

    • updated_at string(date-time) Required

      Timestamp when the incident was last updated (ISO 8601)

  • scheduled_maintenances array[object] Required

    List of upcoming or active scheduled maintenances

    Hide scheduled_maintenances attributes Show scheduled_maintenances attributes object

    • created_at string(date-time) Required

      Timestamp when created (ISO 8601)

    • id string Required

      Unique maintenance identifier

    • impact string Required

      Impact level

      Values are none, minor, major, critical, or maintenance.

    • incident_updates array[object] Required

      List of updates

      Hide incident_updates attributes Show incident_updates attributes object

      • body string Required

        Update message

      • created_at string(date-time) Required

        Timestamp when the update was created (ISO 8601)

      • display_at string(date-time) | null Required

        Timestamp for display (ISO 8601)

      • id string Required

        Unique update identifier

      • incident_id string Required

        Unique incident identifier

      • status string Required

        Update status

        Values are investigating, identified, monitoring, resolved, postmortem, scheduled, in_progress, verifying, or completed.

      • updated_at string(date-time) Required

        Timestamp when the update was last modified (ISO 8601)

    • monitoring_at string(date-time) | null

      Timestamp when monitoring started (ISO 8601)

    • name string Required

      Maintenance name

    • page_id string Required

      Unique page identifier

    • postmortem_body string | null

      Postmortem body

    • postmortem_body_last_updated_at string(date-time) | null

      Timestamp when the postmortem was last updated (ISO 8601)

    • postmortem_ignored boolean

      Whether the postmortem is ignored

    • postmortem_notified_subscribers boolean

      Whether subscribers were notified of the postmortem

    • postmortem_published_at string(date-time) | null

      Timestamp when the postmortem was published (ISO 8601)

    • resolved_at string(date-time) | null

      Timestamp when the maintenance was resolved (ISO 8601)

    • scheduled_for string(date-time) Required

      Scheduled start (ISO 8601)

    • scheduled_remind_prior boolean

      Whether to send reminders prior to the scheduled maintenance

    • scheduled_reminded_at string(date-time) | null

      Timestamp when reminders were sent (ISO 8601)

    • scheduled_until string(date-time) Required

      Scheduled end time (ISO 8601)

    • shortlink string(uri) Required

      Short URL for the maintenance

    • status string Required

      Current maintenance status

      Values are scheduled, in_progress, verifying, or completed.

    • updated_at string(date-time) Required

      Timestamp when the maintenance was last updated (ISO 8601)

  • status object Required
    Hide status attributes Show status attributes object

    • description string Required

      Human-readable description

    • indicator string Required

      Status indicator level

      Values are none, minor, major, or critical.

• 404 application/json

  The requested resource was not found

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • code integer

    Error code

• 500 application/json

  Internal server error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • code integer

    Error code