.. _health_monitor_method_https:
health monitor method https
===========================
HTTPS type
https Specification
-------------------
===================================== ===========================================================================
**Parameter** **Value**
===================================== ===========================================================================
**Type** *Configuration Resource*
**Element Name** https
**Element URI** /axapi/v3/health/monitor/{name}/method/https
**Element Attributes** https_attributes
**Partition Visibility** shared
**Schema** :download:`https schema <health-monitor-method-https/health-monitor-method-https.txt>`
===================================== ===========================================================================
**Operations Allowed:**
.. raw:: html
<script type="text/javascript">
function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
</script>
<table width='90%' style='margin-left:5%'>
.. raw:: html
<tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Create Object
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}/method/https
.. raw:: html
</td><td valign = 'top'>
:ref:`1840_https_attributes`
.. raw:: html
</td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='post_div' style='display:none'>
.. include:: ../artifacts/health_monitor_method_https_POST.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Get Object
.. raw:: html
</td><td valign = 'top'>
GET
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}/method/https
.. raw:: html
</td><td valign = 'top'>
:ref:`1840_https_attributes`
.. raw:: html
</td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='get_div' style='display:none'>
.. include:: ../artifacts/health_monitor_method_https_GET.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Modify Object
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}/method/https
.. raw:: html
</td><td valign = 'top'>
:ref:`1840_https_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Replace Object
.. raw:: html
</td><td valign = 'top'>
PUT
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}/method/https
.. raw:: html
</td><td valign = 'top'>
:ref:`1840_https_attributes`
.. raw:: html
</td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='put_div' style='display:none'>
.. include:: ../artifacts/health_monitor_method_https_PUT.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Delete Object
.. raw:: html
</td><td valign = 'top'>
DELETE
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}/method/https
.. raw:: html
</td><td valign = 'top'>
:ref:`1840_https_attributes`
.. raw:: html
</td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='delete_div' style='display:none'>
.. include:: ../artifacts/health_monitor_method_https_DELETE.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
</table>
.. _1840_https_attributes:
https attributes
----------------
**cert**
**Description** Specify client certificate (Certificate name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 255 characters
**Maximum Length:** 1 characters
**cert-key-shared**
**Description** Select shared partition
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**disable-sslv2hello**
**Description** Disable SSLv2Hello for HTTPs
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**http-version**
**Description** 'http-version2': HTTP version 2 for HTTPs; 'http-version3': HTTP version 3 for HTTPs;
**Type:** string
**Supported Values:** http-version2, http-version3
**https**
**Description** HTTPS type
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**https-encrypted**
**Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)
**https-expect**
**Description** Specify what you expect from the response message
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**https-host**
**Description** Specify "Host:" header used in request (enclose IPv6 address in [])
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**https-kerberos-auth**
**Description** Https Kerberos Auth
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**https-kerberos-kdc**
**Description:** https-kerberos-kdc is a **JSON Block**. Please see below for :ref:`1840_https-kerberos-kdc`
**Type:** Object
**https-kerberos-realm**
**Description** Specify realm of Kerberos server
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**https-key-encrypted**
**Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)
**https-maintenance-code**
**Description** Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899])
**Type:** string
**Format:** string-rlx
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**https-password**
**Description** Specify the user password
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**https-password-string**
**Description** Configure password, '' means empty password
**Type:** string
**Format:** password
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**https-postdata**
**Description** Specify the HTTP post data (Input post data here)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 255 characters
**Maximum Length:** 1 characters
**https-postfile**
**Description** Specify the HTTP post data (Input post data file name here)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**https-response-code**
**Description** Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899])
**Type:** string
**Format:** string-rlx
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**Mutual Exclusion:** https-response-code and https-text are mutually exclusive
**https-server-cert-name**
**Description** Expect Server Cert commonName
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**https-text**
**Description** Specify text expected
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Mutual Exclusion:** https-text, https-response-code, and text-regex are mutually exclusive
**https-url**
**Description** Specify URL string, default is GET /
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**https-username**
**Description** Specify the username
**Type:** string
**Format:** string-rlx
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**key**
**Description** Specify client private key (Key name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 255 characters
**Maximum Length:** 1 characters
**key-pass-phrase**
**Description** Client private key password phrase
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**key-phrase**
**Description** Password Phrase
**Type:** string
**Format:** password
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**maintenance**
**Description** Specify response text for maintenance
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**maintenance-text**
**Description** Specify text for maintenance
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Mutual Exclusion:** maintenance-text and maintenance-text-regex are mutually exclusive
**maintenance-text-regex**
**Description** Specify Regex text for maintenance
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Mutual Exclusion:** maintenance-text-regex and maintenance-text are mutually exclusive
**post-path**
**Description** Specify URL path, default is "/"
**Type:** string
**Format:** string-rlx
**Maximum Length:** 500 characters
**Maximum Length:** 1 characters
**post-type**
**Description** 'postdata': Specify the HTTP post data; 'postfile': Specify the HTTP post data;
**Type:** string
**Supported Values:** postdata, postfile
**response-code-regex**
**Description** Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9])
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**sni**
**Description** Server Name Indication for HTTPs
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**text-regex**
**Description** Specify text expected with Regex
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Mutual Exclusion:** text-regex and https-text are mutually exclusive
**url-path**
**Description** Specify URL path, default is "/"
**Type:** string
**Format:** string-rlx
**Maximum Length:** 500 characters
**Maximum Length:** 1 characters
**url-type**
**Description** 'GET': HTTP GET method; 'POST': HTTP POST method; 'HEAD': HTTP HEAD method;
**Type:** string
**Supported Values:** GET, POST, HEAD
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**web-port**
**Description** Specify HTTPS port (Port Number (default 443))
**Type:** number
**Range:** 1-65534
**Default:** 443
.. _1840_https-kerberos-kdc:
https-kerberos-kdc
^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**https-kerberos-hostip**
**Description** Kdc's hostname(length:1-31) or IP address
**Type:** string
**Format:** host
**Maximum Length:** 31 characters
**Maximum Length:** 1 characters
**Mutual Exclusion:** https-kerberos-hostip and https-kerberos-hostipv6 are mutually exclusive
**https-kerberos-hostipv6**
**Description** Server's IPV6 address
**Type:** string
**Format:** ipv6-address
**Mutual Exclusion:** https-kerberos-hostipv6 and https-kerberos-hostip are mutually exclusive
**https-kerberos-port**
**Description** Specify the kdc port
**Type:** number
**Range:** 1-65535
**https-kerberos-portv6**
**Description** Specify the kdc port
**Type:** number
**Range:** 1-65535