vessels

Create a vessel alert rule

Changed on
post/vessels/alert-rules

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/vessels/alert-rules
  • Auth: one of:
    • API key in cookie session
    • HTTP bearer

Request body

namestring required
conditionstring required
thresholdnumber
severity'info' | 'warning' | 'critical' required
appliesTo'all' | 'fleet' | 'vessel'
targetIdinteger

Response

Alert rule created

idinteger required
namestring required
conditionstring required
thresholdnumber nullable
severity'info' | 'warning' | 'critical' required
isActiveboolean required
appliesTo'all' | 'fleet' | 'vessel'
targetIdinteger nullable

Changes