Skip to content

GET combined ntfn preferences.

GET
/api/web/namespaces/system/user/combined_notifications
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/system/user/combined_notifications \
--header 'Authorization: <Authorization>'

GET combined ntfn preferences gets user-ntfn-preferences and admin-ntfn-preferences and returns combined result.

Examples of this operation.

A successful response.

Media typeapplication/json
NotificationList

List of notifications.

object
notifications
Notifications

List of notifications.

Array<object>
Notification

Definition of existing notifications created for subscription.

object
code
Code

Code of notification.

string
<= 1024 characters
description
Notification

Description text of the notification.

string
>= 21 characters <= 1024 characters
enabled
Enabled

Is it enabled.

boolean format: boolean
label
Label

Public label of the notification.

string
<= 1024 characters
Examplegenerated
{
"notifications": [
{
"code": "example",
"description": "example",
"enabled": true,
"label": "example"
}
]
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example