{
    "id":"/axapi/v3/ddos/notification-template/{name}",
    "type":"object",
    "node-type":"list",
    "title":"notification-template",
    "partition-visibility":"shared",
    "description":"Notification template configuration",
    "properties":{
        "name":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":63,
            "partition-visibility":"shared",
            "description":"DDOS nofitication template name",
            "optional":false
        },
        "disable":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Disable the notification template (Disable notification temaplate)",
            "optional":true
        },
        "test-connectivity":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Test connectivity to notification receiver",
            "optional":true
        },
        "verbose":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Dump zone IPs to the payload",
            "optional":true
        },
        "debug-mode":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Enable debug mode",
            "optional":true
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "user-tag":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":127,
            "partition-visibility":"shared",
            "description":"Customized tag",
            "optional":true
        },
        "api":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/notification-template/{name}/api",
            "properties":{
                "host-ipv4-address":{
                    "type":"string",
                    "format":"ipv4-address",
                    "partition-visibility":"shared",
                    "not-list":[ "host-ipv6-address", "hostname" ],
                    "description":"Configure the host IPv4 address to send notification (IPv4 address of the host)"
                },
                "host-ipv6-address":{
                    "type":"string",
                    "format":"ipv6-address",
                    "partition-visibility":"shared",
                    "not-list":[ "host-ipv4-address", "hostname" ],
                    "description":"Configure the host IPv6 address to send notification (IPv6 address of the host)"
                },
                "hostname":{
                    "type":"string",
                    "format":"string-rlx",
                    "minLength":1,
                    "maxLength":127,
                    "partition-visibility":"shared",
                    "not-list":[ "host-ipv4-address", "host-ipv6-address" ],
                    "description":"host name(e.g www.a10networks.com)"
                },
                "http-protocol":{
                    "type":"string",
                    "format":"enum",
                    "default":"https",
                    "partition-visibility":"shared",
                    "description":"'http': Use http protocol; 'https': Use https protocol(default);  (http protocol)",
                    "enum":[
                        "http",
                        "https"
                    ]
                },
                "http-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "default":80,
                    "partition-visibility":"shared",
                    "description":"Configure the http port to use(default 80) (http port(default 80))"
                },
                "https-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "default":443,
                    "partition-visibility":"shared",
                    "description":"Configure the https port to use(default 443) (https port(default 443))"
                },
                "timeout":{
                    "type":"number",
                    "format":"number",
                    "minimum":5,
                    "maximum":60,
                    "default":10,
                    "partition-visibility":"shared",
                    "description":"Configure the api execution timeout(default 10secs) (api timeout)"
                },
                "relative-uri":{
                    "type":"string",
                    "format":"string-rlx",
                    "minLength":1,
                    "maxLength":127,
                    "default":"/",
                    "partition-visibility":"shared",
                    "description":"Configure the relative uri for the api(e.g /example , default /) (api relative uri)"
                },
                "disable-authentication":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Disable authentication to communicate to the host"
                },
                "use-mgmt-port":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Use management port to send out notification"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "authentication":{
                    "type":"object",
                    "$ref":"/axapi/v3/ddos/notification-template/{name}/api/authentication",
                    "properties":{
                        "relative-login-uri":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Configure the authentication login uri"
                        },
                        "relative-logoff-uri":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Configure the authentication logoff uri"
                        },
                        "auth-username":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Configure the authentication user name"
                        },
                        "auth-password":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Configure the authentication user password (Authentication password)"
                        },
                        "auth-password-val":{
                            "type":"string",
                            "format":"password",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Configure the authentication user password (Authentication password)"
                        },
                        "encrypted":{
                            "type":"encrypted",
                            "format":"encrypted",
                            "partition-visibility":"shared",
                            "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)"
                        },
                        "api-key":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Configure api-key as a mode of authentication"
                        },
                        "api-key-string":{
                            "type":"string",
                            "format":"password",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "description":"Configure api-key as a mode of authentication"
                        },
                        "api-key-encrypted":{
                            "type":"encrypted",
                            "format":"encrypted",
                            "partition-visibility":"shared",
                            "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        }
    },
    "object-keys":[
        "name"
    ],
    "required":[
        "name"
    ]
}