Create ruleset

Create a new ruleset in the rule repository.

POST /monit/store/ruleset/create

Create ruleset

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/monit/store/ruleset/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_ident": "prometheus",
  "note": "CPU usage alerts",
  "open_flag": 1,
  "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]"
}
'

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "id": 1,
    "type_ident": "prometheus",
    "note": "CPU usage alerts",
    "open_flag": 1,
    "created_at": 1712000000,
    "updated_at": 1712000000
  }
}

Restrictions

Aspect	Value
Rate limits	1,000 requests/minute; 50 requests/second per account
Permissions	Rule Repository Manage (monit)

Usage

• open_flag: 0 = private (creator only), 1 = account-shared, 2 = public.
• payload is a required JSON string containing the alert rule definitions.
• Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key · string · query · required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Request body for creating a ruleset. All fields are validated by Validate() on the server.

type_ident · string · required

Datasource type identifier this ruleset applies to, e.g. prometheus.

note · string · required

Description or title of the ruleset.

payload · string · required

JSON string containing the alert rule definitions.

open_flag · enum<integer>

Sharing scope. 0 = private (creator only), 1 = account-shared, 2 = public. Defaults to 0 if omitted.

Available options: 0, 1, 2

Response

200

application/json

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id · string · required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · required

A rule repository ruleset.

Show child attributes