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
选填

排序项和顺序,例如 ‘id DESC’

Validations:

  • Must be a String

page
选填

页号,从 1 开始

Validations:

  • Must be a number.

per_page
选填

每页中显示的返回结果数

Validations:

  • Must be a number.

搜索字段

字段名 类型 可能的值
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
必填

数字 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