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

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