Update a alert-rule

PUT

/alert-rules/{id}

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Path Parameters

id

required

string

DocumentId

Request Body ^required

object

data

object

name

required

string

description

string

metric

required

string

Allowed values: cpu_percent memory_percent disk_percent network_in_bytes network_out_bytes load_average

operator

required

string

Allowed values: gt gte lt lte eq

threshold

required

number

severity

required

string

Allowed values: info warning critical

enabled

boolean

instanceId

Target cloud instance ID, or ’*’ for all instances

string

provider

string

Allowed values: aws gcp azure digitalocean hetzner ovhcloud scaleway upcloud any

cooldownMinutes

Minimum minutes between repeated alerts for the same rule+instance

integer

notifyEmail

Comma-separated email addresses for alert notifications

string

notifyWebhookUrl

HTTP endpoint to POST alert payload to

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

createdBy

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

home_region

required

Logical data-residency region of the tenant (CELL invariant, F2.CELL.01)

string

Allowed values: eu us apac

cell_id

Deployment cell within home_region for blast-radius isolation (CELL invariant, F2.CELL.01)

string

Responses

200

Updated

object

data

object

name

required

string

description

string

metric

required

string

Allowed values: cpu_percent memory_percent disk_percent network_in_bytes network_out_bytes load_average

operator

required

string

Allowed values: gt gte lt lte eq

threshold

required

number

severity

required

string

Allowed values: info warning critical

enabled

boolean

instanceId

Target cloud instance ID, or ’*’ for all instances

string

provider

string

Allowed values: aws gcp azure digitalocean hetzner ovhcloud scaleway upcloud any

cooldownMinutes

Minimum minutes between repeated alerts for the same rule+instance

integer

notifyEmail

Comma-separated email addresses for alert notifications

string

notifyWebhookUrl

HTTP endpoint to POST alert payload to

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

createdBy

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

home_region

required

Logical data-residency region of the tenant (CELL invariant, F2.CELL.01)

string

Allowed values: eu us apac

cell_id

Deployment cell within home_region for blast-radius isolation (CELL invariant, F2.CELL.01)

string

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)

404

Not found