visibility reporting notification-template¶
Notification template configuration
notification-template Specification¶
Type Collection Object Key(s) name Collection Name notification-template-list Collection URI /axapi/v3/visibility/reporting/notification-template Element Name notification-template Element URI /axapi/v3/visibility/reporting/notification-template/{name} Element Attributes notification-template_attributes Schema notification-template schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/reporting/notification-template | ||
Create List | POST | /axapi/v3/visibility/reporting/notification-template | ||
Get Object | GET | /axapi/v3/visibility/reporting/notification-template/{name} | ||
Get List | GET | /axapi/v3/visibility/reporting/notification-template | ||
Modify Object | POST | /axapi/v3/visibility/reporting/notification-template/{name} | ||
Replace Object | PUT | /axapi/v3/visibility/reporting/notification-template/{name} | ||
Replace List | PUT | /axapi/v3/visibility/reporting/notification-template | ||
Delete Object | DELETE | /axapi/v3/visibility/reporting/notification-template/{name} |
notification-template-list¶
notification-template-list is JSON List of notification-template attributes
notification-template-list : [
notification-template attributes¶
action
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: disable
authentication
Description: authentication is a JSON Block. Please see below for authentication
Type: Object
Refernce Object: /axapi/v3/visibility/reporting/notification-template/{name}/authentication
host-name
Description Configure the host name(e.g www.a10networks.com)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: host-name ipv4-address and ipv6-address are mutually exclusive
ipv4-address
Description Configure the host IPv4 address
Type: string
Format: ipv4-address
Mutual Exclusion: ipv4-address ipv6-address and host-name are mutually exclusive
ipv6-address
Description Configure the host IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-address ipv4-address and host-name are mutually exclusive
name
Description Notification template name
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
port
Description Configure the http port to use(default 443)
Type: number
Range: 1-65535
Default: 443
protocol
Description ‘http’: Use http protocol; ‘https’: Use https protocol(default); (http protocol)
Type: string
Supported Values: http, https
Default: https
relative-uri
Description Configure the relative uri(e.g /example , default /)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: /
use-mgmt-port
Description Use management port for notifications
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
authentication¶
Specification Type object auth-password
Description Configure the authentication user password (Authentication password)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auth-password-string
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