Skip to main content
POST
Update ruleset

Restrictions

Usage

  • 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

Parameters for updating a ruleset.

id
integer<uint64>
required

Ruleset ID to update.

note
string
required

New description.

payload
string
required

New JSON string of alert rule definitions.

open_flag
enum<integer>

New sharing scope. 0 = private, 1 = account-shared, 2 = public.

Available options:
0,
1,
2

Response

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.