REST endpoints: Notifications and history

These endpoints mirror the CLI commands described in Notifications, Browsing notification history. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

GET /notifications/query

Query past notifications.

CLI command: notifications query

Query parameters

Name	Type	Required	Description
nodes	array of string	No	The names of the S1 nodes to get notifications from. Defaults to all nodes.
minLevel	string	No	Filter by minimum notification level.
levels	array of string	No	Filter by specific event levels.
modules	array of string	No	Filter by notification module names.
startTimestamp	date-time	No	Filter by start date/time, in ISO 8601 format (e.g. YYYY-MM-DDTHH:MM:SS).
endTimestamp	date-time	No	Filter by end date/time, in ISO 8601 format (e.g. YYYY-MM-DDTHH:MM:SS).
search	string	No	A string to search for. Hint: you can search customer, system (cloud), node and module names.
top	integer	No	Limit the number of results returned.
descendingOrder	boolean	No	Sort the results in descending order.

Response: a list of NotificationElement objects in Result.NotificationElement, each with: Timestamp (date-time), Level (string: Verbose / Debug / Information / Warning / Error).

PUT /notifications/settings/email/edit

Edit email notification settings.

CLI command: notifications settings email edit

Body fields (JSON)

Name	Type	Required	Description
MailServerAddress	string	No	Mail server address.
MailServerPort	integer	No	Mail server port.
MailServerUsername	string	No	Mail server username.
MailServerPassword	string	No	Mail server password.
SendFromAddress	string	No	The address notifications are sent from, if different from the username (or if no username is set).
SecureSocketOption	string	No	Encryption to use when connecting to the mail server: None: No SSL/TLS encryption. Auto: Let the implementation choose SSL or TLS (default). Falls back to no encryption if the server does not support SSL or TLS. SslOnConnect: Use SSL or TLS encryption immediately upon connecting. StartTls: Elevate to TLS encryption immediately after reading the server's greeting and capabilities. StartTlsWhenAvailable: Elevate to TLS encryption immediately after reading the server's greeting and capabilities, but only if the server supports STARTTLS.
EnableCertificateValidation	boolean	No	Validate the certificate presented by the server when establishing a secure connection (default). In REST one field covers a pair of CLI flags: true applies --enableCertificateValidation, false applies --disableCertificateValidation, and omitting the field applies neither.

PUT /notifications/settings/email/reset

Reset email settings to default values.

CLI command: notifications settings email reset

Body fields (JSON)

Name	Type	Required	Description
Force	boolean	No	Skip the confirmation prompt.

GET /notifications/settings/email/show

Display email settings.

CLI command: notifications settings email show

This endpoint takes no parameters.

Response: an object of type NotificationsEmailSettingsElement in Result, with: MailServerAddress (string), MailServerPort (integer), MailServerUsername (string), MailServerPassword (string), SendFromAddress (string), SecureSocketOption (string), EnableCertificateValidation (boolean).

POST /notifications/test

Generate a test notification.

CLI command: notifications test

Body fields (JSON)

Name	Type	Required	Description
Node	string	Yes	The name of the S1 node that will generate the notification.
Level	string	Yes	Notification level.
Module	string	Yes	Notification module name.
Message	string	Yes	Notification message.
Force	boolean	No	Skip the confirmation prompt when email settings have not been configured.

---

See also: Requests and responses - Authentication - Examples