/config/alert/custom/{idx}/frequency

The frequency with which this custom alert should be checked. Possible values are:

  • sec: The alert will be checked once a second.
  • min: The alert will be checked once a minute.
  • hr: The alert will be checked once an hour.
  • dy: The alert will be checked once a day.
  • wk: The alert will be checked once a week.
  • mon: The alert will be checked once a month.
  • an: The alert will be checked once a year.

Get /config/alert/custom/{idx}/frequency

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Responses
200

Normal response.

401

Unauthorized response.

get/config/alert/custom/{idx}/frequency
Request samples
Response samples
application/json
{
  • "result": "sec",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/alert/custom/{idx}/frequency

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Request Body schema: application/json
string (configAlertCustomItemFrequency)

The frequency with which this custom alert should be checked. Possible values are:

  • sec: The alert will be checked once a second.
  • min: The alert will be checked once a minute.
  • hr: The alert will be checked once an hour.
  • dy: The alert will be checked once a day.
  • wk: The alert will be checked once a week.
  • mon: The alert will be checked once a month.
  • an: The alert will be checked once a year.
Enum: "sec" "min" "hr" "dy" "wk" "mon" "an"
Responses
200

Normal response.

401

Unauthorized response.

put/config/alert/custom/{idx}/frequency
Request samples
application/json
"sec"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/alert/custom/{idx}/frequency

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Request Body schema: application/json
string (configAlertCustomItemFrequency)

The frequency with which this custom alert should be checked. Possible values are:

  • sec: The alert will be checked once a second.
  • min: The alert will be checked once a minute.
  • hr: The alert will be checked once an hour.
  • dy: The alert will be checked once a day.
  • wk: The alert will be checked once a week.
  • mon: The alert will be checked once a month.
  • an: The alert will be checked once a year.
Enum: "sec" "min" "hr" "dy" "wk" "mon" "an"
Responses
200

Normal response.

401

Unauthorized response.

post/config/alert/custom/{idx}/frequency
Request samples
application/json
"sec"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/alert/custom/{idx}/frequency

Reset to sec.

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Responses
200

Normal response.

401

Unauthorized response.

delete/config/alert/custom/{idx}/frequency
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}