Skip to content
Sencai Logo Sencai Logo Sencai Docs

List alert-rules

GET
/alert-rules

Threshold-based alert rules for monitoring provisioned cloud VMs

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
pagination[page]
integer
pagination[pageSize]
integer
filters

Strapi REST filter syntax

object
sort
string
populate
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
data
Array
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:

DocumentId reference to api::organisation.organisation

string
createdBy
One of:

DocumentId reference to plugin::users-permissions.user

string
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
meta
object
pagination
object
page
integer
pageSize
integer
pageCount
integer
total
integer

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

Not authorized (tenant scope or capability)