PATCH /actiongroupconfig/{uuid}

PATCH /actiongroupconfig/{uuid}

/actiongroupconfig/{uuid}

Request
URI
PATCH
https://api_host/api/actiongroupconfig/{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
ActionGroupConfig of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "action_script_config_ref": "string",
    "autoscale_trigger_notification": false,
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "email_config_ref": "string",
    "external_only": false,
    "level": "string",
    "name": "string",
    "snmp_trap_profile_ref": "string",
    "syslog_config_ref": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

string
action_script_config_ref
Optional

reference of the action script configuration to be used. It is a reference to an object of type AlertScriptConfig. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
autoscale_trigger_notification
Optional

Trigger Notification to AutoScale Manager. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
description
Optional

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

string
email_config_ref
Optional

Select the Email Notification configuration to use when sending alerts via email. It is a reference to an object of type AlertEmailConfig. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
external_only
Required

Generate Alert only to external destinations. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

string
level
Required

When an alert is generated, mark its priority via the Alert Level. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

string
snmp_trap_profile_ref
Optional

Select the SNMP Trap Notification to use when sending alerts via SNMP Trap. It is a reference to an object of type SnmpTrapProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
syslog_config_ref
Optional

Select the Syslog Notification configuration to use when sending alerts via Syslog. It is a reference to an object of type AlertSyslogConfig. 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
url
Optional

url

string
uuid
Optional

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

Responses
200

OK

Returns ActionGroupConfig of type(s) application/json 
{
    "_last_modified": "string",
    "action_script_config_ref": "string",
    "autoscale_trigger_notification": false,
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "email_config_ref": "string",
    "external_only": false,
    "level": "string",
    "name": "string",
    "snmp_trap_profile_ref": "string",
    "syslog_config_ref": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

string
action_script_config_ref
Optional

reference of the action script configuration to be used. It is a reference to an object of type AlertScriptConfig. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
autoscale_trigger_notification
Optional

Trigger Notification to AutoScale Manager. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
description
Optional

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

string
email_config_ref
Optional

Select the Email Notification configuration to use when sending alerts via email. It is a reference to an object of type AlertEmailConfig. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
external_only
Required

Generate Alert only to external destinations. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

string
level
Required

When an alert is generated, mark its priority via the Alert Level. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

string
snmp_trap_profile_ref
Optional

Select the SNMP Trap Notification to use when sending alerts via SNMP Trap. It is a reference to an object of type SnmpTrapProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
syslog_config_ref
Optional

Select the Syslog Notification configuration to use when sending alerts via Syslog. It is a reference to an object of type AlertSyslogConfig. 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
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

On This Page
Action Group Config Operations
DELETE
DELETE /actiongroupconfig/{uuid}
GET
GET /actiongroupconfig
GET
GET /actiongroupconfig/{uuid}
PATCH
PATCH /actiongroupconfig/{uuid}
POST
POST /actiongroupconfig
PUT
PUT /actiongroupconfig/{uuid}