Avi AlertEmailConfig Object API

##CLI## ``` - configure alertemailconfig - show alertemailconfig - test alerttestemail ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /alertemailconfig
  2. post /alertemailconfig
  3. post /alertemailconfig/{uuid}/alerttestemail
  4. delete /alertemailconfig/{uuid}
  5. get /alertemailconfig/{uuid}
  6. patch /alertemailconfig/{uuid}
  7. put /alertemailconfig/{uuid}
Up
get /alertemailconfig
(alertemailconfigGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AlertEmailConfigApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "to_emails" : "aeiou",
    "cc_emails" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertEmailConfigApiResponse

401

log in failed

Up
post /alertemailconfig
(alertemailconfigPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AlertEmailConfig object creation

Return type

AlertEmailConfig

Example data

Content-Type: application/json
{
  "to_emails" : "aeiou",
  "cc_emails" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertEmailConfig

401

log in failed

Up
post /alertemailconfig/{uuid}/alerttestemail
(alertemailconfigUuidAlerttestemailPost)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AlertTestEmailParams

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
delete /alertemailconfig/{uuid}
(alertemailconfigUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /alertemailconfig/{uuid}
(alertemailconfigUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AlertEmailConfig

Example data

Content-Type: application/json
{
  "to_emails" : "aeiou",
  "cc_emails" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertEmailConfig

401

log in failed

Up
patch /alertemailconfig/{uuid}
(alertemailconfigUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AlertEmailConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AlertEmailConfig

Example data

Content-Type: application/json
{
  "to_emails" : "aeiou",
  "cc_emails" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertEmailConfig

401

log in failed

Up
put /alertemailconfig/{uuid}
(alertemailconfigUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AlertEmailConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AlertEmailConfig

Example data

Content-Type: application/json
{
  "to_emails" : "aeiou",
  "cc_emails" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertEmailConfig

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AlertEmailConfig
  2. AlertEmailConfigApiResponse
  3. AlertTestEmailParams

AlertEmailConfig Up

cc_emails (optional)
String Alerts are copied to the comma separated list of email recipients.
description (optional)
String User defined description for the object.
name
String A user-friendly name of the email notification service.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
to_emails
String Alerts are sent to the comma separated list of email recipients.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

AlertEmailConfigApiResponse Up

count
Integer format: int32
results

AlertTestEmailParams Up

subject
String The Subject line of the originating email from Avi Controller.
text
String The email context.
uuid (optional)
String Unique object identifier of the object.