Skip to main content

Documentation index for AI agents: llms.txt. Every page here is also served as markdown: add .md to its address, or request it with Accept: text/markdown.

CreateAlertRuleRequest data model

The CreateAlertRuleRequest shape in the Visual Sentinel REST API.

Fields

FieldTypeRequiredDescription
namestringYesMin length 1, max length 100.
descriptionstringNoMax length 500.
monitorIdstring (uuid) or nullNoDefault: null.
conditionsobject or object or array of object or objectYesA response time or uptime condition, or a list of them that must all be true. Down alerts, repeated failures and SSL expiry are sent by the built-in alerts, so rules do not accept them.
severitystringNoOne of: INFO, WARNING, CRITICAL. Default: WARNING.
cooldownMinutesnumberNoDefault: 5. Greater than 0.
notificationChannelIdsarray of string (uuid)NoDefault: [].
enabledbooleanNoDefault: true.
scheduleStartstring or nullNo
scheduleEndstring or nullNo
timezonestringNoDefault: UTC.

Used by

Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.