POST
/
monitors
curl --request POST \
  --url https://api.axiom.co/v2/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alertOnNoData": true,
  "aplQuery": "<string>",
  "columnName": "<string>",
  "compareDays": 6,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "description": "<string>",
  "disabled": true,
  "disabledUntil": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "intervalMinutes": 2,
  "name": "<string>",
  "notifierIds": [
    "<string>"
  ],
  "notifyByGroup": true,
  "notifyEveryRun": true,
  "operator": "Below",
  "rangeMinutes": 2,
  "resolvable": true,
  "secondDelay": 123,
  "skipResolved": true,
  "threshold": 123,
  "tolerance": 99,
  "triggerAfterNPositiveResults": 123,
  "triggerFromNRuns": 123,
  "type": "Threshold"
}'
{
  "alertOnNoData": true,
  "aplQuery": "<string>",
  "columnName": "<string>",
  "compareDays": 6,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "description": "<string>",
  "disabled": true,
  "disabledUntil": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "intervalMinutes": 2,
  "name": "<string>",
  "notifierIds": [
    "<string>"
  ],
  "notifyByGroup": true,
  "notifyEveryRun": true,
  "operator": "Below",
  "rangeMinutes": 2,
  "resolvable": true,
  "secondDelay": 123,
  "skipResolved": true,
  "threshold": 123,
  "tolerance": 99,
  "triggerAfterNPositiveResults": 123,
  "triggerFromNRuns": 123,
  "type": "Threshold"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
name
string
required
​
alertOnNoData
boolean
​
aplQuery
string
​
columnName
string
​
compareDays
number
Required range: x < 7
​
createdAt
string
​
createdBy
string
​
description
string
​
disabled
boolean
​
disabledUntil
string | null
​
id
string
​
intervalMinutes
integer
Required range: x > 1
​
notifierIds
string[]
​
notifyByGroup
boolean
​
notifyEveryRun
boolean
​
operator
enum<string>
Available options:
Below,
BelowOrEqual,
Above,
AboveOrEqual,
AboveOrBelow
​
rangeMinutes
integer
Required range: x > 1
​
resolvable
boolean
​
secondDelay
number
Required range: x < 86400
​
skipResolved
boolean
​
threshold
number
​
tolerance
number
Required range: x < 100
​
triggerAfterNPositiveResults
number
​
triggerFromNRuns
number
​
type
enum<string>
Available options:
Threshold,
MatchEvent,
AnomalyDetection

Response

200 - application/json
Monitor
​
name
string
required
​
alertOnNoData
boolean
​
aplQuery
string
​
columnName
string
​
compareDays
number
Required range: x < 7
​
createdAt
string
​
createdBy
string
​
description
string
​
disabled
boolean
​
disabledUntil
string | null
​
id
string
​
intervalMinutes
integer
Required range: x > 1
​
notifierIds
string[]
​
notifyByGroup
boolean
​
notifyEveryRun
boolean
​
operator
enum<string>
Available options:
Below,
BelowOrEqual,
Above,
AboveOrEqual,
AboveOrBelow
​
rangeMinutes
integer
Required range: x > 1
​
resolvable
boolean
​
secondDelay
number
Required range: x < 86400
​
skipResolved
boolean
​
threshold
number
​
tolerance
number
Required range: x < 100
​
triggerAfterNPositiveResults
number
​
triggerFromNRuns
number
​
type
enum<string>
Available options:
Threshold,
MatchEvent,
AnomalyDetection

Was this page helpful?

Suggest editsRaise issue
Retrieve monitorUpdate monitor