HomeRelease Notes
API Reference
API Reference

Search Incidents

post
https://{domain}/api/v4/incidents
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The input.

Class IncidentSearchApiDto. Implements the StatusCast.Services.Shared.Paging.SimplePagedAndSortedInputDto

string
enum

Sorting

Members:

  • Ascending - Ascending from A-Z
  • Descending - Descending from Z-A

Allowed:
int32 | null
1 to 10000

Page number

int32 | null
1 to 100

Page size

int32 | null

A specific incident id to search for

boolean

Return counts only

boolean

Filter incidents by subscriber groups

string
enum

Members:

    Allowed:
    string
    enum

    Members:

    • All - All incidents, no filter
    • Closed - Only incidents with EndDate set
    • OpenStarted - Open incidents that have already started and have not closed yet
    • AllFuture - All incidents that are scheduled for the future, dependent of incident type
    • ScheduledFuture - All incidents scheduled for the future that are only of ScheduledMaintenance type
    • OpenAll - All open incident (no EndDate specified) irrelevant of start date and type.
    • ScheduledFutureOpenOnly - All incidents scheduled for the future that are only of ScheduledMaintenance type
    string
    enum

    Members:

      Allowed:
      groupIds
      array of int32s | null

      Filter by group ids

      groupIds
      string | null

      Filter by a keyword

      string | null

      Filter by external id

      components
      array of int64s | null

      Filter by affected components

      components
      date-time | null

      Filter by start date before

      date-time | null

      Filter by end date before

      date-time | null

      Filter by start date after

      date-time | null

      Filter by end date after

      string | null

      Filter by created username or email address

      boolean | null

      Filter date between start and end dates

      boolean | null

      Include external statuspage incidents

      boolean | null

      Include incidents not in groups

      boolean | null

      Include local incidents (non-statuspage) incidents

      incidentTypes
      array of objects | null

      Filter by incident type

      incidentTypes
      string
      enum

      Incident Update Type

      Members:

      • Informational - Informational
      • Closed - Closed
      • RootCause - Root Cause
      • Investigating - Investigating
      • Monitoring - Monitoring
      • Identified - Identified
      • Migration - Identified

      Allowed:
      Responses

      401

      Unauthorized

      403

      Forbidden

      405

      NotAllowed

      Updated about 1 year ago

      Language
      Credentials
      Bearer
      JWT
      URL
      LoadingLoading…
      Response
      Click Try It! to start a request and see the response here! Or choose an example:
      application/json

      Updated about 1 year ago