Notification - Inbox, Settings & Devices¶

View your notification inbox, manage notification settings, and registered push-notification devices.

Commands¶

notification inbox - List inbox notifications
notification unread-count - Show the number of unread notifications
notification read - Mark notification(s) as read
notification settings get - Show resolved notification settings
notification settings set - Set a notification override for a module
notification settings delete - Delete notification overrides (reset to defaults)
notification devices list - List registered devices
notification devices remove - Remove registered device(s)

notification inbox¶

List notifications from your inbox with page-based pagination and filtering.

mysecutec notification inbox [flags]

Flags¶

Flag	Type	Default	Description
`--page`	int	`1`	Page number
`--page-size`	int	`20`	Number of results per page
`--unread`	bool	`false`	Show only unread notifications
`--read`	bool	`false`	Show only read notifications
`--module`	string		Filter by module name
`--severity`	string		Filter by severity

API¶

1	`GET /notification/v1/inbox`

Query Parameters:

Parameter	Type	Description
`page`	int	Page number
`page_size`	int	Results per page
`is_read`	bool	Read/unread filter (set by `--read`/`--unread`)
`module_name`	string	Module name filter
`severity`	string	Severity filter

Request Example¶

mysecutec notification inbox --module sdns --severity high --page 2 --page-size 50

GET /notification/v1/inbox?page=2&page_size=50&module_name=sdns&severity=high
Authorization: Bearer <token>
Accept: application/json

notification unread-count¶

Show the number of unread notifications in your inbox.

1	`mysecutec notification unread-count`

API¶

1	`GET /notification/v1/inbox/unread-count`

Request Example¶

1	`mysecutec notification unread-count`

GET /notification/v1/inbox/unread-count
Authorization: Bearer <token>
Accept: application/json

notification read¶

Mark a single notification as read by ID, or mark all notifications as read with --all. Both actions modify state and prompt for confirmation unless --yes is given.

mysecutec notification read [id] [flags]

Flags¶

Flag	Type	Default	Description
`--all`	bool	`false`	Mark all notifications as read
`-y, --yes`	bool	`false`	Skip the confirmation prompt

API¶

PATCH /notification/v1/inbox/{id}/read
POST  /notification/v1/inbox/mark-all-read

The PATCH endpoint is used when an id is supplied; the POST endpoint is used with --all.

Request Example¶

mysecutec notification read 1a2b3c4d-5678-90ab-cdef-1234567890ab --yes

PATCH /notification/v1/inbox/1a2b3c4d-5678-90ab-cdef-1234567890ab/read
Authorization: Bearer <token>
Accept: application/json

mysecutec notification read --all --yes

POST /notification/v1/inbox/mark-all-read
Authorization: Bearer <token>
Accept: application/json

notification settings get¶

Show resolved notification settings at the user, tenant, or per-user (admin) scope.

Scopes:

user - resolved settings for the current user (default)
tenant - tenant-level settings (admin)
users - all users with their resolved settings (admin); pass --user-id for one user.

mysecutec notification settings get [flags]

Flags¶

Flag	Type	Default	Description
`--scope`	string	`user`	Settings scope: `user`, `tenant`, or `users`
`--user-id`	string		User ID (only with `--scope users`)

API¶

GET /notification/v1/settings                  (scope=user)
GET /notification/v1/settings/tenant           (scope=tenant)
GET /notification/v1/settings/users            (scope=users)
GET /notification/v1/settings/users/{userID}   (scope=users with --user-id)

Request Example¶

mysecutec notification settings get --scope users --user-id 1a2b3c4d-5678-90ab-cdef-1234567890ab

GET /notification/v1/settings/users/1a2b3c4d-5678-90ab-cdef-1234567890ab
Authorization: Bearer <token>
Accept: application/json

notification settings set¶

Set the email/push/in-app override for a single module. This is a state-changing operation and prompts for confirmation unless --yes is given.

mysecutec notification settings set [flags]

Flags¶

Flag	Type	Default	Description
`--module`	string		Module name to override (required)
`--email`	bool	`false`	Enable email notifications for the module
`--push`	bool	`false`	Enable push notifications for the module
`--in-app`	bool	`false`	Enable in-app notifications for the module
`--scope`	string	`user`	Settings scope: `user`, `tenant`, or `users`
`--user-id`	string		User ID (only with `--scope users`)
`-y, --yes`	bool	`false`	Skip the confirmation prompt

API¶

PUT /notification/v1/settings                  (scope=user)
PUT /notification/v1/settings/tenant           (scope=tenant)
PUT /notification/v1/settings/users            (scope=users)
PUT /notification/v1/settings/users/{userID}   (scope=users with --user-id)

Request Example¶

mysecutec notification settings set --module sdns --email --in-app --no-push --yes

PUT /notification/v1/settings
Authorization: Bearer <token>
Content-Type: application/json

{
  "module_name": "sdns",
  "email": true,
  "push": false,
  "in_app": true
}

notification settings delete¶

Delete all notification overrides for the chosen scope, resetting to inherited defaults. This is a state-changing operation and prompts for confirmation unless --yes is given.

mysecutec notification settings delete [flags]

Flags¶

Flag	Type	Default	Description
`--scope`	string	`user`	Settings scope: `user`, `tenant`, or `users`
`--user-id`	string		User ID (only with `--scope users`)
`-y, --yes`	bool	`false`	Skip the confirmation prompt

API¶

DELETE /notification/v1/settings                  (scope=user)
DELETE /notification/v1/settings/tenant           (scope=tenant)
DELETE /notification/v1/settings/users            (scope=users)
DELETE /notification/v1/settings/users/{userID}   (scope=users with --user-id)

Request Example¶

mysecutec notification settings delete --scope tenant --yes

DELETE /notification/v1/settings/tenant
Authorization: Bearer <token>
Accept: application/json

notification devices list¶

List devices registered for push notifications.

mysecutec notification devices list

API¶

1	`GET /notification/v1/devices`

Request Example¶

mysecutec notification devices list

GET /notification/v1/devices
Authorization: Bearer <token>
Accept: application/json

notification devices remove¶

Unregister a single device by its push token (--token), or remove all registered devices (--all). Both actions modify state and prompt for confirmation unless --yes is given.

mysecutec notification devices remove [flags]

Flags¶

Flag	Type	Default	Description
`--token`	string		Device token to unregister
`--all`	bool	`false`	Remove all registered devices
`-y, --yes`	bool	`false`	Skip the confirmation prompt

API¶

DELETE /notification/v1/devices/unregister?device_token=<token>   (--token)
DELETE /notification/v1/devices                                   (--all)

Request Example¶

mysecutec notification devices remove --token abc123deviceToken --yes

DELETE /notification/v1/devices/unregister?device_token=abc123deviceToken
Authorization: Bearer <token>
Accept: application/json

mysecutec notification devices remove --all --yes

DELETE /notification/v1/devices
Authorization: Bearer <token>
Accept: application/json