alertRules

Create an alert rule

Requires the ALERT_RULE.CREATE permission.

post/v{version}/alert-rules

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/alert-rules
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
referencestring required

A custom reference assigned to the alert.

namestring nullable

A custom name assigned to the alert.

descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'

The status of the AlertRule. DEPRECATED is not supported.

customer_idsstring[] nullable

The IDs of the customers linked to the alert.

type'ENTITLEMENT' | 'INVOICE' required

The type of the the alert.

trigger_type'STATIC' | 'DYNAMIC'

Response

Created

object_typestring nullable
idstring nullable
referencestring

A custom reference assigned to the alert.

namestring nullable

A custom name assigned to the alert.

descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'

The status of the AlertRule. DEPRECATED is not supported.

customer_idsstring[] nullable

The IDs of the customers linked to the alert.

type'ENTITLEMENT' | 'INVOICE'

The type of the the alert.

trigger_type'STATIC' | 'DYNAMIC'

Changes

No recorded changes to this operation across all 1 revision of this API.