PUT /alertemailconfig/{uuid}

PUT /alertemailconfig/{uuid}

/alertemailconfig/{uuid}

Request
URI
PUT
https://{api_host}/api/alertemailconfig/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

AlertEmailConfig object creation

AlertEmailConfig of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "to_emails": "string"
}
{
    "_last_modified": "string",
    "cc_emails": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "name": "string",
    "tenant_ref": "string",
    "to_emails": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns AlertEmailConfig of type(s) application/json 
"AlertEmailConfig Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
cc_emails
Optional

Alerts are copied to the comma separated list of email recipients. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
configpb_attributes
Optional

configpb_attributes

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

A user-friendly name of the email notification service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
to_emails
Required

Alerts are sent to the comma separated list of email recipients. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","to_emails:"string"}' https://{api_host}/api/alertemailconfig/{uuid}
On This Page
Alert Email Config Operations
GET
GET /alertemailconfig
POST
POST /alertemailconfig
GET
GET /alertemailconfig/{uuid}
PUT
PUT /alertemailconfig/{uuid}
PATCH
PATCH /alertemailconfig/{uuid}
DELETE
DELETE /alertemailconfig/{uuid}
POST
POST /alertemailconfig/{uuid}/testemail