Deleting a destination address for error notification emails

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
You can delete a destination address for error notification emails. These notification emails are used to report service information messages (SIMs) of storage systems. This API allows you to delete one destination address at a time.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Note:
  • To delete all destination addresses at once, disable the setting for sending error notification emails.

  • If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Storage Administrator (Initial Configuration)

Request line

POST base-URL/v1/objects/alert-email-settings/instance/actions/remove-recipient-address/invoke

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query parameters
None.
Body
{
     "parameters": {
         "address"   : "to@example.com"
     }
}

Attribute

Type

Description

address

string

(Required) A destination address for error notification emails that you want to delete.

Specify a name consisting of 1 to 255 characters.

You can use the following characters:

  • Alphanumeric characters
  • The following symbols:

    ! # $ % & ' * + - . = ? @ ^ _ ` { | } ~

You cannot use spaces.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL for acquiring settings information about an error notification email

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/alert-email-settings/instance/actions/remove-recipient-address/invoke