POST /systemconfiguration/systestemail

POST /systemconfiguration/systestemail

/systemconfiguration/systestemail

Request
URI
POST
https://{api_host}/api/systemconfiguration/systestemail
COPY
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

SysTestEmailParams

SysTestEmailParams of type(s) application/json
Required

Show optional properties

{
    "subject": "string",
    "text": "string",
    "to_emails": "string"
}
{
    "cc_emails": "string",
    "subject": "string",
    "text": "string",
    "to_emails": "string"
}
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.

string
subject
Required

The Subject line of the originating email from Avi Controller. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
text
Required

The email context. 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.

Responses
200

OK

Returns string of type(s) application/json
Operation doesn't return any data structure

401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"subject:"string","text:"string","to_emails:"string"}' https://{api_host}/api/systemconfiguration/systestemail
On This Page
System Configuration Operations
GET
GET /systemconfiguration
PUT
PUT /systemconfiguration
PATCH
PATCH /systemconfiguration
GET
GET /systemconfiguration/{uuid}
PUT
PUT /systemconfiguration/{uuid}
PATCH
PATCH /systemconfiguration/{uuid}
DELETE
DELETE /systemconfiguration/{uuid}
POST
POST /systemconfiguration/systestemail