Skip to content

notification_digest_settings

Configuration for Notification Digest Settings resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
WeeklyFeaturesList <String> Read-write List of events for which notification is to be generated weekly..
scheduleTimesEpoch <String> Read-write Schedule time epoch (string representation of 11 digit numbers)..
slack_profile <String> Read-write Slack Profile.
tz_offset <Integer> Read-write Time zone offset..
scheduleOptions <String> Read-write Comma separated Options for scheduling Configuration Template.
ImmediateFeaturesList <String> Read-write List of events for which notification is to be generated immediately..
MonthlyFeaturesList <String> Read-write List of events for which notification is to be generated monthly..
nextScheduleTimeEpoch <String> Read-write Schedule time epoch at which job is scheduled to be run next..
id <String> Read-write Id is system generated for each setting.
DailyFeaturesList <String> Read-write List of events for which notification is to be generated daily..
notification_period <String> Read-write notification_period.
mail_profile <String> Read-write Mail Profile.
tenant_id <String> Read-only Tenant Id of the Notification Jobs.

Operations

(click to see Properties )

  • GET (ALL)
  • GET
  • UPDATE

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/notification_digest_settings

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/notification_digest_settings ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of notification_digest_settings resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/notification_digest_settings ?pagesize=#no;pageno=#no

Use this query-parameter to get the notification_digest_settings resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/notification_digest_settings ?count=yes

Use this query-parameter to get the count of notification_digest_settings resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "notification_digest_settings":[{
      "WeeklyFeaturesList":<String_value>,
      "scheduleTimesEpoch":<String_value>,
      "slack_profile":<String_value>,
      "tz_offset":<Integer_value>,
      "scheduleOptions":<String_value>,
      "ImmediateFeaturesList":<String_value>,
      "MonthlyFeaturesList":<String_value>,
      "tenant_id":<String_value>,
      "nextScheduleTimeEpoch":<String_value>,
      "id":<String_value>,
      "DailyFeaturesList":<String_value>,
      "notification_period":<String_value>,
      "mail_profile":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/notification_digest_settings/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "notification_digest_settings":[{
      "WeeklyFeaturesList":<String_value>,
      "scheduleTimesEpoch":<String_value>,
      "slack_profile":<String_value>,
      "tz_offset":<Integer_value>,
      "scheduleOptions":<String_value>,
      "ImmediateFeaturesList":<String_value>,
      "MonthlyFeaturesList":<String_value>,
      "tenant_id":<String_value>,
      "nextScheduleTimeEpoch":<String_value>,
      "id":<String_value>,
      "DailyFeaturesList":<String_value>,
      "notification_period":<String_value>,
      "mail_profile":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/notification_digest_settings/id_value<String>

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"notification_digest_settings":{
<b>      "id":<String_value></b>,
<b>      "notification_period":<String_value></b>,
      "WeeklyFeaturesList":<String_value>,
      "slack_profile":<String_value>,
      "mail_profile":<String_value>,
      "scheduleTimesEpoch":<String_value>,
      "scheduleOptions":<String_value>,
      "tz_offset":<Integer_value>,
      "ImmediateFeaturesList":<String_value>,
      "MonthlyFeaturesList":<String_value>,
      "DailyFeaturesList":<String_value>,
      "nextScheduleTimeEpoch":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "notification_digest_settings":[{
      "WeeklyFeaturesList":<String_value>,
      "scheduleTimesEpoch":<String_value>,
      "slack_profile":<String_value>,
      "tz_offset":<Integer_value>,
      "scheduleOptions":<String_value>,
      "ImmediateFeaturesList":<String_value>,
      "MonthlyFeaturesList":<String_value>,
      "tenant_id":<String_value>,
      "nextScheduleTimeEpoch":<String_value>,
      "id":<String_value>,
      "DailyFeaturesList":<String_value>,
      "notification_period":<String_value>,
      "mail_profile":<String_value>}]}
Was this article helpful?