ddos notification-template¶
Notification template configuration
notification-template Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name notification-template-list Collection URI /axapi/v3/ddos/notification-template Element Name notification-template Element URI /axapi/v3/ddos/notification-template/{name} Element Attributes notification-template_attributes Partition Visibility shared Schema notification-template schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/notification-template | ||
Create List | POST | /axapi/v3/ddos/notification-template | ||
Get Object | GET | /axapi/v3/ddos/notification-template/{name} | ||
Get List | GET | /axapi/v3/ddos/notification-template | ||
Modify Object | POST | /axapi/v3/ddos/notification-template/{name} | ||
Replace Object | PUT | /axapi/v3/ddos/notification-template/{name} | ||
Replace List | PUT | /axapi/v3/ddos/notification-template | ||
Delete Object | DELETE | /axapi/v3/ddos/notification-template/{name} |
notification-template-list¶
notification-template-list is JSON List of notification-template attributes
notification-template-list : [
notification-template attributes¶
api
Description: api is a JSON Block. Please see below for api
Type: Object
Reference Object: /axapi/v3/ddos/notification-template/{name}/api
debug-mode
Description Enable debug mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable
Description Disable the notification template (Disable notification temaplate)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description DDOS nofitication template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
test-connectivity
Description Test connectivity to notification receiver
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
verbose
Description Dump zone IPs to the payload
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
api¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for api_authentication
Type: Object
Reference Object: /axapi/v3/ddos/notification-template/{name}/api/authentication
disable-authentication
Description Disable authentication to communicate to the host
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
host-ipv4-address
Description Configure the host IPv4 address to send notification (IPv4 address of the host)
Type: string
Format: ipv4-address
Mutual Exclusion: host-ipv4-address, host-ipv6-address, and hostname are mutually exclusive
host-ipv6-address
Description Configure the host IPv6 address to send notification (IPv6 address of the host)
Type: string
Format: ipv6-address
Mutual Exclusion: host-ipv6-address, host-ipv4-address, and hostname are mutually exclusive
hostname
Description host name(e.g www.a10networks.com)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: hostname, host-ipv4-address, and host-ipv6-address are mutually exclusive
http-port
Description Configure the http port to use(default 80) (http port(default 80))
Type: number
Range: 1-65535
Default: 80
http-protocol
Description ‘http’: Use http protocol; ‘https’: Use https protocol(default); (http protocol)
Type: string
Supported Values: http, https
Default: https
https-port
Description Configure the https port to use(default 443) (https port(default 443))
Type: number
Range: 1-65535
Default: 443
relative-uri
Description Configure the relative uri for the api(e.g /example , default /) (api relative uri)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: /
timeout
Description Configure the api execution timeout(default 10secs) (api timeout)
Type: number
Range: 5-60
Default: 10
use-mgmt-port
Description Use management port to send out notification
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
api_authentication¶
Specification Value Type object api-key
Description Configure api-key as a mode of authentication
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
api-key-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)api-key-string
Description Configure api-key as a mode of authentication
Type: string
Format: password
Maximum Length: 64 characters
Maximum Length: 1 characters
auth-password
Description Configure the authentication user password (Authentication password)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auth-password-val
Description Configure the authentication user password (Authentication password)
Type: string
Format: password
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-username
Description Configure the authentication user name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)relative-login-uri
Description Configure the authentication login uri
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
relative-logoff-uri
Description Configure the authentication logoff uri
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters