Jump to

• Request
• Response

Get a list of incidents

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents

Returns a list of incidents based on the filters specified. By default, it returns the first set of all open incidents with the most recently created incidents listed first.

Request

Query Parameters

• ageInHoursLessThanOrEqualTo: integer(int32)
  Get incidents which are newer than the number of days specified

  Default Value: 744

  Example:

  24

• includeMemberTargets: boolean
  Include matching incidents on members of the given target

  Default Value: true
• limit: integer(int32)
  Limits number of items returned in current call. Use the self/previous/next links from the response to fetch additional items.

  Default Value: 50
• page: string
  Identifies the set of items to be fetched; "href" element from "links" list of the response provides encoded value for this parameter. "href" element value should be used "as is" for fetching respective set of items.

  Default Value: Base64 encode value of 0 i.e MA==
• severity: array[]
  Filter by specified severities
• sort: string
  Sort results by attributes such as id, displayId, timeCreated, timeUpdated, status and owner

  Example:

  displayId:ASC,timeUpdated:DESC

• targetName: string
  Filter by specific target name.
• targetTypeName: string
  Filter by specific target type.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation - Fetch incident list

Body ()

Root Schema : IncidentCollection

List of incident summary

Match All

Show Source

• object ListRspns
  Generic list response wrapper
• object IncidentCollection-allOf[1]

{
    "description":"List of incident summary",
    "allOf":[
        {
            "$ref":"#/components/schemas/ListRspns"
        },
        {
            "required":[
                "items"
            ],
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of the incident summary",
                    "items":{
                        "$ref":"#/components/schemas/IncidentSummary"
                    }
                }
            }
        }
    ]
}

Nested Schema : ListRspns

Type: object

Generic list response wrapper

Show Source

• count(required): integer (int32)
  Number of rows returned

  Example: 1
• links: object links
  Read Only: true

  URL links to paginated resource(s).

{
    "required":[
        "count"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of rows returned",
            "format":"int32",
            "example":1
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links to paginated resource(s).",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/incidents?page=MQ%3D%3D&limit=50"
                },
                "next":{
                    "href":"/em/api/incidents?page=Mg%3D%3D&limit=50"
                },
                "previous":{
                    "href":"/em/api/incidents?page=MA%3D%3D&limit=50"
                }
            }
        }
    },
    "description":"Generic list response wrapper"
}

Nested Schema : IncidentCollection-allOf[1]

Type: object

Show Source

• items(required): array items
  List of the incident summary

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of the incident summary",
            "items":{
                "$ref":"#/components/schemas/IncidentSummary"
            }
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

URL links to paginated resource(s).

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• previous: object Link
  Represents a link(could be self, previous or next)
• self(required): object Link
  Represents a link(could be self, previous or next)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links to paginated resource(s).",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/incidents?page=MQ%3D%3D&limit=50"
        },
        "next":{
            "href":"/em/api/incidents?page=Mg%3D%3D&limit=50"
        },
        "previous":{
            "href":"/em/api/incidents?page=MA%3D%3D&limit=50"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/incidents?page=MQ%3D%3D&limit=50"
    },
    "next":{
        "href":"/em/api/incidents?page=Mg%3D%3D&limit=50"
    },
    "previous":{
        "href":"/em/api/incidents?page=MA%3D%3D&limit=50"
    }
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : items

Type: array

List of the incident summary

Show Source

• Array of: object IncidentSummary
  Summary of an incident

{
    "type":"array",
    "description":"List of the incident summary",
    "items":{
        "$ref":"#/components/schemas/IncidentSummary"
    }
}

Nested Schema : IncidentSummary

Type: object

Summary of an incident

Show Source

• ageInHours: integer (int64)
  Read Only: true

  Incident age in hours

  Example: 855
• canBeManuallyClosed: boolean
  Default Value: false

  Can the incident be cleared by user?

  Example: true
• displayId(required): integer (int64)
  Read Only: true

  Display ID of the incident

  Example: 35
• escalationLevel: object EscalationLevel
  Details of an escalation level
• id(required): string (raw)
  Read Only: true

  ID of the incident

  Example: C4E214A1172A2F19E053860E4B645AC7
• isDiagnosticIncident: boolean
  Default Value: false

  Is it a Automatic Diagnostic Repository (ADR) incident?

  Example: false
• isEscalated: boolean
  Is the incident escalated?

  Example: true
• isOpen(required): boolean
  Is the incident open?

  Example: true
• links: object links
  Read Only: true

  URL links inside details of resource.
• message(required): string
  Message of the incident

  Example: CPU Utilization is 10.821%, crossed warning (5) or critical (10) threshold.
• nonTargetEntities: array nonTargetEntities
  Minimum Number of Items: 0

  Unique Items Required: true

  Entities (jobs, etc.) other than targets which are affected by this incident
• owner: string
  Current owner of the incident

  Example: SYSMAN
• priority: object Priority
  Details of an priority
• severity(required): string
  Read Only: true

  Allowed Values: [ "FATAL", "CRITICAL", "WARNING", "MINOR_WARNING", "CLEAR" ]

  Supported list of the severities

  Example: CRITICAL
• status(required): string
  Current status of the incident

  Example: new
• suppressionStatus: object SuppressionStatus
  Details of an suppression status
• targets: array targets
  Minimum Number of Items: 0

  Unique Items Required: true

  Targets affected by this incident
• ticket: object TicketSummary
  Read Only: true

  Details of the ticket
• timeCreated(required): string (date-time)
  Read Only: true

  Time when incident is created

  Example: 2021-06-16T12:17:56.000Z
• timeUpdated(required): string (date-time)
  Read Only: true

  Time when incident is updated

  Example: 2021-07-22T06:25:42.000Z

{
    "required":[
        "displayId",
        "id",
        "isOpen",
        "message",
        "severity",
        "status",
        "timeCreated",
        "timeUpdated"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the incident",
            "format":"raw",
            "readOnly":true,
            "example":"C4E214A1172A2F19E053860E4B645AC7"
        },
        "displayId":{
            "type":"integer",
            "description":"Display ID of the incident",
            "format":"int64",
            "readOnly":true,
            "example":35
        },
        "message":{
            "type":"string",
            "description":"Message of the incident",
            "example":"CPU Utilization is 10.821%, crossed warning (5) or critical (10) threshold."
        },
        "targets":{
            "minItems":0,
            "uniqueItems":true,
            "type":"array",
            "description":"Targets affected by this incident",
            "items":{
                "$ref":"#/components/schemas/Target"
            }
        },
        "nonTargetEntities":{
            "minItems":0,
            "uniqueItems":true,
            "type":"array",
            "description":"Entities (jobs, etc.) other than targets which are affected by this incident",
            "items":{
                "$ref":"#/components/schemas/SourceEntity"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Time when incident is created",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-06-16T12:17:56.000Z"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Time when incident is updated",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-07-22T06:25:42.000Z"
        },
        "ageInHours":{
            "type":"integer",
            "description":"Incident age in hours",
            "format":"int64",
            "readOnly":true,
            "example":855
        },
        "isOpen":{
            "type":"boolean",
            "description":"Is the incident open?",
            "example":true
        },
        "status":{
            "type":"string",
            "description":"Current status of the incident",
            "example":"new"
        },
        "owner":{
            "type":"string",
            "description":"Current owner of the incident",
            "example":"SYSMAN"
        },
        "isEscalated":{
            "type":"boolean",
            "description":"Is the incident escalated?",
            "example":true
        },
        "escalationLevel":{
            "$ref":"#/components/schemas/EscalationLevel"
        },
        "priority":{
            "$ref":"#/components/schemas/Priority"
        },
        "suppressionStatus":{
            "$ref":"#/components/schemas/SuppressionStatus"
        },
        "severity":{
            "$ref":"#/components/schemas/Severity"
        },
        "canBeManuallyClosed":{
            "type":"boolean",
            "description":"Can the incident be cleared by user?",
            "example":true,
            "default":false
        },
        "ticket":{
            "$ref":"#/components/schemas/TicketSummary"
        },
        "isDiagnosticIncident":{
            "type":"boolean",
            "description":"Is it a Automatic Diagnostic Repository (ADR) incident?",
            "example":false,
            "default":false
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links inside details of resource.",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7"
                }
            }
        }
    },
    "description":"Summary of an incident"
}

Nested Schema : EscalationLevel

Type: object

Details of an escalation level

Show Source

• displayName: string
  Display name of the escalation level

  Example: None
• name(required): string
  Read Only: true

  Allowed Values: [ "NONE", "L1", "L2", "L3", "L4", "L5" ]

  Supported list of the escalataion levels

  Example: NONE

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/EscalationLevels"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the escalation level",
            "example":"None"
        }
    },
    "description":"Details of an escalation level"
}

Nested Schema : links

Type: object

Read Only: true

URL links inside details of resource.

Show Source

• self(required): object Link
  Represents a link(could be self, previous or next)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links inside details of resource.",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7"
    }
}

Nested Schema : nonTargetEntities

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Entities (jobs, etc.) other than targets which are affected by this incident

Show Source

• Array of: object SourceEntity
  Details of an source entity

{
    "minItems":0,
    "uniqueItems":true,
    "type":"array",
    "description":"Entities (jobs, etc.) other than targets which are affected by this incident",
    "items":{
        "$ref":"#/components/schemas/SourceEntity"
    }
}

Nested Schema : Priority

Type: object

Details of an priority

Show Source

• displayName: string
  Read Only: true

  Display label for the priority

  Example: None
• name(required): string
  Internal name for the priority

  Example: PRIORITY_NONE

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Internal name for the priority",
            "example":"PRIORITY_NONE"
        },
        "displayName":{
            "type":"string",
            "description":"Display label for the priority",
            "readOnly":true,
            "example":"None"
        }
    },
    "description":"Details of an priority"
}

Nested Schema : SuppressionStatus

Type: object

Details of an suppression status

Show Source

• isSuppressed(required): boolean
  Default Value: false

  Is the supression enabled?
• suppressUntil: string
  Allowed Values: [ "MANUALLY_UNSUPPRESSED", "INCIDENT_CLOSES", "INCIDENT_SEVERITY_CHANGES", "AFTER_A_DAY", "AFTER_A_WEEK", "AFTER_DATE" ]

  Supression type
• timeToEndSuppression: string (date-time)
  Supression end time

{
    "required":[
        "isSuppressed"
    ],
    "type":"object",
    "properties":{
        "isSuppressed":{
            "type":"boolean",
            "description":"Is the supression enabled?",
            "default":false
        },
        "suppressUntil":{
            "type":"string",
            "description":"Supression type",
            "enum":[
                "MANUALLY_UNSUPPRESSED",
                "INCIDENT_CLOSES",
                "INCIDENT_SEVERITY_CHANGES",
                "AFTER_A_DAY",
                "AFTER_A_WEEK",
                "AFTER_DATE"
            ]
        },
        "timeToEndSuppression":{
            "type":"string",
            "description":"Supression end time",
            "format":"date-time"
        }
    },
    "description":"Details of an suppression status"
}

Nested Schema : targets

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Targets affected by this incident

Show Source

• Array of: object schema
  Target details

{
    "minItems":0,
    "uniqueItems":true,
    "type":"array",
    "description":"Targets affected by this incident",
    "items":{
        "$ref":"#/components/schemas/Target"
    }
}

Nested Schema : TicketSummary

Type: object

Read Only: true

Details of the ticket

Show Source

• id: string
  Read Only: true

  ID of the ticket

  Example: 51d62b6cd1384ba89aeddfa647ea1380
• status: string
  Status of the ticket

  Example: Triggered
• type: string
  Type of the ticket

  Example: TICKET
• url: string
  URL of the ticket

  Example: https://api.pagerduty.com/incidents?incident_key=F746283FHDKC

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the ticket",
            "readOnly":true,
            "example":"51d62b6cd1384ba89aeddfa647ea1380"
        },
        "status":{
            "type":"string",
            "description":"Status of the ticket",
            "example":"Triggered"
        },
        "type":{
            "type":"string",
            "description":"Type of the ticket",
            "example":"TICKET"
        },
        "url":{
            "type":"string",
            "description":"URL of the ticket",
            "example":"https://api.pagerduty.com/incidents?incident_key=F746283FHDKC"
        }
    },
    "description":"Details of the ticket",
    "readOnly":true
}

Nested Schema : SourceEntity

Type: object

Details of an source entity

Show Source

• id(required): string (raw)
  ID of the entity

  Example: 317C6AD6C69832D0ADDA279BEB7B7F32
• name(required): string
  Name of the entity

  Example: bkupjob-123456
• subTypeDisplayName: string
  Display name for sub type for an entity type

  Example: Database backup job
• subTypeName: string
  Sub type for an entity type

  Example: DBBackupJob
• typeDisplayName: string
  Display name for the entity type

  Example: Job
• typeName(required): string
  Type of the entity

  Example: JOB

{
    "required":[
        "id",
        "name",
        "typeName"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the entity",
            "format":"raw",
            "example":"317C6AD6C69832D0ADDA279BEB7B7F32"
        },
        "name":{
            "type":"string",
            "description":"Name of the entity",
            "example":"bkupjob-123456"
        },
        "typeName":{
            "type":"string",
            "description":"Type of the entity",
            "example":"JOB"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Display name for the entity type",
            "example":"Job"
        },
        "subTypeName":{
            "type":"string",
            "description":"Sub type for an entity type",
            "example":"DBBackupJob"
        },
        "subTypeDisplayName":{
            "type":"string",
            "description":"Display name for sub type for an entity type",
            "example":"Database backup job"
        }
    },
    "description":"Details of an source entity"
}

Nested Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

  Example: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top