Mail notifications

>>>

GET /api/mail_notifications
Список всех почтовых уведомлений

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
search
необязательно

отфильтровать результаты

Validations:

  • Must be a String
order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.
per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
description
name
user
>>>

GET /api/mail_notifications/:id
Показать почтовое уведомление

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Цифровой код или имя почтового уведомления

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/users/:user_id/mail_notifications
Add an email notification for a user

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
обязательно

Validations:

  • Must be a String
mail_notification_id
обязательно

Validations:

  • Must be a Integer
interval
необязательно

Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

Validations:

  • Must be a String
subscription
необязательно

Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

Validations:

  • Must be a String
mail_query
необязательно

Relevant only for audit summary notification

Validations:

  • Must be a String
>>>

PUT /api/users/:user_id/mail_notifications/:mail_notification_id
Update an email notification for a user

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
обязательно

Validations:

  • Must be a String
mail_notification_id
обязательно

Validations:

  • Must be a Integer
interval
необязательно

Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

Validations:

  • Must be a String
subscription
необязательно

Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

Validations:

  • Must be a String
mail_query
необязательно

Relevant only for audit summary notification

Validations:

  • Must be a String
>>>

DELETE /api/users/:user_id/mail_notifications/:mail_notification_id
Remove an email notification for a user

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
обязательно

Validations:

  • Must be a String
mail_notification_id
обязательно

Validations:

  • Must be a Integer
>>>

GET /api/users/:user_id/mail_notifications
List all email notifications for a user

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
обязательно

Validations:

  • Must be a String