{
    "id":"/axapi/v3/ddos/notification-template/{name}/api",
    "type":"object",
    "node-type":"scalar",
    "title":"api",
    "partition-visibility":"shared",
    "description":"Violation action notification api configuration",
    "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)",
            "optional":true
        },
        "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)",
            "optional":true
        },
        "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)",
            "optional":true
        },
        "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"
            ],
            "optional":true
        },
        "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))",
            "optional":true
        },
        "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))",
            "optional":true
        },
        "timeout":{
            "type":"number",
            "format":"number",
            "minimum":5,
            "maximum":60,
            "default":10,
            "partition-visibility":"shared",
            "description":"Configure the api execution timeout(default 10secs) (api timeout)",
            "optional":true
        },
        "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)",
            "optional":true
        },
        "disable-authentication":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Disable authentication to communicate to the host",
            "optional":true
        },
        "use-mgmt-port":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Use management port to send out notification",
            "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
        },
        "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"
                }
            }
        }
    }
}