PUT Notification Channels

Updates the configurations for the notification channels that are used for alerting. At this time, the list includes SMTP server configuration used for sending alert emails.

Request

URI

PUT

https://{api_host}/api/v1/notification/channels

COPY

Request Body

notification.channels.put.request of type(s) application/json

Optional

{
    "channels": [
        {
            "type": "email",
            "config": {
                "server": "smtp.example.com",
                "port": 25,
                "sslAuth": false,
                "tls": false,
                "defaultSender": "[email protected]",
                "login": "[email protected]",
                "password": "",
                "acceptCert": false
            }
        }
    ]
}

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Successfully updated the SMTP configurations used for sending alert emails.

Operation doesn't return any data structure

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v1/notification/channels

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Notification Operations

GET

GET Notification Channels

PUT