GET /api/mail_notifications
Lista de notificações por emails

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
description
name
user

GET /api/mail_notifications/:id
Mostrar uma notificação por email

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

ID numerica ou nome do email de notificação

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
requerido

Validations:

  • Must be a String

mail_notification_id
requerido

Validations:

  • Must be a Integer

interval
opcional

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

Validations:

  • Must be a String

subscription
opcional

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
opcional

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
requerido

Validations:

  • Must be a String

mail_notification_id
requerido

Validations:

  • Must be a Integer

interval
opcional

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

Validations:

  • Must be a String

subscription
opcional

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
opcional

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
requerido

Validations:

  • Must be a String

mail_notification_id
requerido

Validations:

  • Must be a Integer


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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
requerido

Validations:

  • Must be a String