GET Notification Channels

GET Notification Channels

Gets a list of all the notification channels that are used for alerting. At this time, the list includes SMTP server configuration used for sending alert emails.

Request
URI
GET
https://{api_host}/api/v2/notification/channels
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the SMTP server configuration used for sending email alerts.

Returns notification.channels.get.response of type(s) application/json 
{
    "channels": [
        {
            "type": "email",
            "config": {
                "server": "smtp.example.com",
                "port": 25,
                "sslAuth": false,
                "tls": false,
                "defaultSender": "[email protected]",
                "login": "[email protected]",
                "password": ""
            }
        }
    ]
}

401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json 
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/notification/channels
On This Page
Notification Operations
GET
GET Notification Channels
PUT
PUT Notification Channels
GET
GET Notification Email
PUT
PUT Notification Email
GET
GET Notification Webhook
PUT
PUT Notification Webhook
POST
POST Notification Webhook
GET
GET Notification Webhook Webhook Id
PUT
PUT Notification Webhook Webhook Id
DELETE
DELETE Notification Webhook Webhook Id
GET
GET Notification Webhook Webhook Id Alerts
GET
GET Notification Config Retention Threshold
PUT
PUT Notification Config Retention Threshold