SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Incidents and Alerts API

When a condition (a signal) in the systems you're monitoring matches a detector rule, the detector triggers an alert event. The detector triggers a clear event when the signal no longer matches the rule.
The alert and clear event for a single trigger are an incident.

Retrieve Incidents

Retrieves information for all incidents

get /incident

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/incident

Retrieves the information for all incidents associated with the organization of the user that makes the request

query Parameters
offset
integer <int32>

The result object in the result set at which the API should start returning results to you. If omitted, the API starts at the first result in the set.

limit
integer <int32>

The number of results to return from the result set.

includeResolved
boolean
Default: false

Controls which incidents to retrieve, based on their status. If the value is true, the API returns incidents for which the status is "resolved"; otherwise, the API only returns active incidents.

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to retrieve incidents.

Responses

200

Successful retrieval of incident information

Response Schema: application/json
results
Array of object (RetrieveIncidentResponseObject)

An array of incident objects, each of which contains the data for one incident

Response samples

application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ]
}

Retrieve Incidents For A Detector

Retrieves incidents for the detector specified in the {id} path parameter

get /incident/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/incident/{id}

Retrieves incidents for the detector specified in the {id} path parameter.

path Parameters
id
required
string

The id of an existing detector for which you want to retrieve incident data.

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to retrieve incidents.

Responses

200

Successful retrieval of the incident data for the detector

Response Schema: application/json
incidentId
string

The SignalFx-assigned identifier for the incident

detectorId
string

The SignalFx-assigned identifier of the detector that generated the events in the incident

detectLabel
string

The label of the SignalFlow program that generated the events in the incident. This program is specified in the detector.

active
boolean

Flag that indicates if the incident is still ongoing ("active").

severity
string <Capitalized>
Enum:"Critical" "Major" "Minor" "Warning" "Info"

The severity of the incident. You set this value in the specification of the detector that triggered the alert events in this incident.
NOTE: This is an enum, and you must specify it exactly as described.

anomalyState
string
Enum:"TOO_HIGH" "OK" "TOO_LOW" "ANOMALOUS" "INCONCLUSIVE" "STOPPED" "CLEARED"

The incident's current anomaly state. This is a short description of the current signal status compared to its expected state.

events
Array of object (IncidentEventObject)

A array that contains the event objects for this incident

duration
integer <int64>

If the incident is resolved, this is the time in milliseconds that elapsed between the alert event and the clear event. For unresolved events, this property isn't present.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "incidentId": "string",
  • "detectorId": "string",
  • "detectLabel": "string",
  • "active": true,
  • "severity": "Critical",
  • "anomalyState": "TOO_HIGH",
  • "events":
    [
    ],
  • "duration": 0
}

Clear Single Incident

Clears the incident (sends a clear event) specified in the {id} path parameter

put /incident/{id}/clear

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/incident/{id}/clear

Manually clear an incident specified by its ID, specified in the {id} path parameter.
Unlike some other incident APIs, this API can be used with incidents related to detectors created in the web UI as well as detectors created using the v2 API.

path Parameters
id
required
string

The id of an existing incident that you want to clear

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to clear incidents.

Responses

200

Successfully cleared the event

Retrieve Alert Muting Rules Using Query

Retrieves alerting muting rules based on search criteria

get /alertmuting

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/alertmuting

Retrieves alerting muting rules based on the query you specify in the query query parameter

query Parameters
query
string

Query that specifies the muting rules you want to retrieve.

include
string

Specifies the type of muting rules you want to retrieve. The allowed values are:

  • Past
  • Future
  • Ongoing
  • Open
  • All
offset
integer <int32>

The result object in the result set at which the API should start returning results to you. If omitted, the API starts at the first result in the set.

limit
integer <int32>

The number of results to return from the result set.

orderBy
string

The metadata property on which the API should sort the results. You don't have to include this property in the query, but the name must be a property of alert muting rules.

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to retrieve alert muting rules. Unlike the detector APIs, you can use the alert muting APIs with detectors you create in the web UI as well as detectors you create with the API.

Responses

200

Successfully retrieved alert muting rules, or no rules matched the search criteria

Create Single Alert Muting Rule

Creates a new alert muting rule

post /alertmuting

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/alertmuting

Creates a new alert muting rule, based on the specifications in the request body. Unlike the detector APIs, you can use the alert muting APIs with detectors you create in the web UI as well as detectors you create with the API.

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to create alert muting rules.

Request Body schema: application/json
filters
Array of object (AlertMutingFilterObject)

An array of alert muting filters

Responses

200

Successful creation of an alert muting rule. The API doesn't return a response body.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "filters":
    [
    ]
}

Retrieve Alert Muting Rule Using ID

Retrieves an alert muting rule specified in the {id} path parameter

get /alertmuting/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/alertmuting/{id}

Retrieves an alert muting rule, based on an rule ID specified in the {id} path parameter. Unlike the detector APIs, you can use the alert muting APIs with detectors you create in the web UI as well as detectors you create with the API.

path Parameters
id
required
string

The SignalFx-assigned ID of an alerting muting rule

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to retrieve alert muting rules

Responses

200

Successful retrieval of an alert muting rule

Response Schema: application/json
filters
Array of object (AlertMutingFilterObject)

An array of alert muting filters

Response samples

application/json
Copy
Expand all Collapse all
{
  • "filters":
    [
    ]
}

Update Single Alert Muting Rule

Updates the alert muting rule specified in the {id} path parameter

put /alertmuting/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/alertmuting/{id}

Updates the alert muting rule specified in the {id} path parameter, using the values specified in the request body. Unlike the detector APIs, you can use the alert muting APIs with detectors you create in the web UI as well as detectors you create with the API.

path Parameters
id
required
string

The SignalFx-assigned ID of an alerting muting rule

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to update alert muting rules

Responses

200

Successfully deleted the alert muting rule

Delete Single Alert Muting Rule

Deletes an alert muting rule specified in the {id} path parameter

delete /alertmuting/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/alertmuting/{id}

Deletes an alert muting rule, specified by the rule ID in the {in} path parameter. Unlike the detector APIs, you can use the alert muting APIs with detectors you create in the web UI as well as detectors you create with the API.
Note: You can't delete alerting muting rules that started in the past.

path Parameters
id
required
string

The SignalFx-assigned ID of an alerting muting rule

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to update alert muting rules

Responses

200

Successful deletion of an alert muting rule that starts in the future.

400

Bad request, for example, you tried to delete an alert muting rule that starts in the past

404

An alert muting rule for the ID you specified doesn't exist.

Unmute Single Alert Muting Rule

Ends the active muting period for an alert specified in the {id} path parameter

put /alertmuting/{id}/unmute

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/alertmuting/{id}/unmute

Ends a muting period that's currently active and updates the stop time to the current server time. Unlike some other incident APIs, this API can be used with incidents related to detectors created in the web UI as well as detectors created using the v2 API.

path Parameters
id
required
string

The SignalFx-assigned ID of an alerting muting rule

header Parameters
X-SF-Token
required
string

An access token (referred to as a User ID access token in the web UI) for a user that has authorization to update alert muting rules

Responses

200

Successfully unmuted an alert

Response Schema: application/json
id
string

The alert muting rule ID

description
string

A short description of the alert muting rule

startTime
integer <int64>

The scheduled start time for the alert muting rule, in Unix time UTC-relative.

stopTime
integer <in64>

The scheduled end time for the alert muting rule, in Unix time UTC-relative.

filters
Array of object (AlertMutingBody)

Array of alert muting filters

creator
string

The user ID of the user that created the alert muting rule

created
integer <int64>

The creation date and time of the alert muting rule, in Unix time UTC-relative.

lastUpdatedBy
string

The user ID of the user that last updated the alert muting rule

lastUpdated
integer <int64>

The last updated date and time of the alert muting rule, in Unix time UTC-relative.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "description": "string",
  • "startTime": 1556706630000,
  • "stopTime": 1557052230000,
  • "filters":
    [
    ],
  • "creator": "string",
  • "created": 1555324230000,
  • "lastUpdatedBy": "string",
  • "lastUpdated": 1555497030000
}

© Copyright 2019 SignalFx.

Third-party license information