v2

latestSwagger 2.02026-07-26109144190.4 KB

Alerts

Retrieve alert details.

Retrieve the details of an alert that was sent VictorOps by you.

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

get/api-public/v1/alerts/{uuid}

uuidstring required

The VictorOps uuid of the alert

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

The alert, if found.

messageTypestring

The type of alert; INFO, WARNING, ACKNOWLEDGEMENT, CRITICAL, RECOVERY

entityIdstring

Identifies the entity (host, service, etc.) this alert was about.

timestampnumber

Timestamp of the alert in seconds since epoch.

stateStartTimenumber

The time this entity entered its current state (seconds since epoch).

stateMessagestring

Any additional status information from the alert item.

monitoringToolstring

The name of the monitoring system software (eg. nagios, icinga, sensu, etc.)

entityDisplayNamestring

Used within VictorOps to display a human-readable name for the entity.

ackMsgstring

A user entered comment for the acknowledgment.

ackAuthorstring

The user that acknowledged the incident.

rawstring

The full, raw alert details JSON string (i.e. parse the string into a JSON object)