v2

latestSwagger 2.02026-07-26109144190.4 KB

Incidents

Get a single incident

Get detailed data for a single incident with the provided incident number, if it exists. The incident will be returned regardless if it is active or not.

This API may be called a maximum of 2 times per second.

get/api-public/v1/incidents/{incidentNumber}

Path parameters

incidentNumberinteger required

The Victorops incident number

Headers

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

Response

A single incident matching the provided incident number

incidentNumberstring

The VictorOps incident number

startTimestring

The time the incident started

The format of the start time is in yyyy-MM-dd'T'HH:mm:ssZ.

currentPhase'RESOLVED' | 'UNACKED' | 'ACKED'

The current phase of the incident can be resolved, triggered (UNACKED) or acknowledged (ACKED).

alertCountnumber

The number of alerts received for this incident

lastAlertTimestring

The time of the last alert received for the incident

The format of the last alert time is in yyyy-MM-dd'T'HH:mm:ssZ.

lastAlertIdstring

The UUID of the last alert for the incident

entityIdstring

The unique identification of the entity being monitored that caused the incident

hoststring

The host on which the incident occurred

servicestring

The service name causing the incident (if any)

pagedUsersstring[]

A list of the Victorops usernames of the users that were paged for the incident.

pagedTeamsstring[]

The teams that were paged for the incident

This is a list of the team slugs of the teams that were paged.

The team slug is in the format team-[\w\d]{16}

firstAlertUuidstring

The UUID of the first alert for this incident.

You can use this id to call the get alert endpoint in the Alerts section (/api-public/v1/alerts/{uuid}) to get more information about the alert that started this incident.

The state message field for the first alert will have the original, more detailed description of the incident.

monitorNamestring

This is the name of the creator of this incident. If this incident was manually triggered, this is the username of the user that triggered it. If this incident was not manually triggered, this is the name of the service that triggered it.

The format for manual creation is vouser-{username}.

The format for a system creating an incident is {service-name}.

The type of the monitor of the incident, as named in the monitorName, that triggered the incident. Either manual (if a user created the incident) or the name of the service that triggered the incident