POST /alertsyslogconfig

POST /alertsyslogconfig

/alertsyslogconfig

Request
URI
POST
https://api_host/api/alertsyslogconfig
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
AlertSyslogConfig of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "name": "string",
    "sender_hostname": "string",
    "syslog_servers": [
        {
            "anon_auth": false,
            "format": "string",
            "pkiprofile_ref": "string",
            "ssl_key_and_certificate_ref": "string",
            "strict_cert_verify": false,
            "syslog_server": "string",
            "syslog_server_port": 0,
            "tls_enable": false,
            "udp": false
        }
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
description
Optional

User defined description for alert syslog config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

string
sender_hostname
Optional

User defined sender hostname in syslog message. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of AlertSyslogServer
syslog_servers
Optional

The list of syslog servers. 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 AlertSyslogConfig of type(s) application/json 
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "name": "string",
    "sender_hostname": "string",
    "syslog_servers": [
        {
            "anon_auth": false,
            "format": "string",
            "pkiprofile_ref": "string",
            "ssl_key_and_certificate_ref": "string",
            "strict_cert_verify": false,
            "syslog_server": "string",
            "syslog_server_port": 0,
            "tls_enable": false,
            "udp": false
        }
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
description
Optional

User defined description for alert syslog config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

string
sender_hostname
Optional

User defined sender hostname in syslog message. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of AlertSyslogServer
syslog_servers
Optional

The list of syslog servers. 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
Alert Syslog Config Operations
DELETE
DELETE /alertsyslogconfig/{uuid}
GET
GET /alertsyslogconfig
GET
GET /alertsyslogconfig/{uuid}
PATCH
PATCH /alertsyslogconfig/{uuid}
POST
POST /alertsyslogconfig
POST
POST /alertsyslogconfig/{uuid}/testsyslog
PUT
PUT /alertsyslogconfig/{uuid}