.. _domain_list:

domain-list
===========

Configure Domain classification list


domain-list Specification
-------------------------

	===================================== ===========================================================
	 **Parameter**                         **Value** 

	===================================== ===========================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`1446_domain-list_list`

	 **Collection URI**                    /axapi/v3/domain-list

	                                       

	 **Element Name**                      domain-list

	 **Element URI**                       /axapi/v3/domain-list/{name}

	 **Element Attributes**                domain-list_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/domain-list/{name}/oper

	 **Schema**                             :download:`domain-list schema <domain-list/domain-list.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/domain-list



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_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/domain_list_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/domain-list



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_attributes`



.. raw:: html

   </td><td></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/domain-list/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_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/domain_list_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/domain-list



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_list`



.. raw:: html

   </td><td></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/domain-list/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_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/domain-list/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_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/domain_list_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/domain-list



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_list`



.. raw:: html

   </td><td></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/domain-list/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`1446_domain-list_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/domain_list_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _1446_domain-list_list:

domain-list-list
----------------


    domain-list-list is **JSON List** of :ref:`1446_domain-list_attributes` 

        domain-list-list : [

             { :ref:`1446_domain-list_attributes` },

             { :ref:`1446_domain-list_attributes` },

             ...

         ]

.. _1446_domain-list_attributes:

domain-list attributes
----------------------

    **domain-name-list**

        **Type:** List

    **file**

        **Description** Create/Edit a domain-list stored as a file

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **match-type-axfr**

        **Type:** List

    **match-type-equals**

        **Type:** List

    **match-type-suffix**

        **Type:** List

    **name**

        **Description** Specify name of the domain list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **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

.. _1446_match-type-suffix:

match-type-suffix
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **suffix**

        **Description** Specify suffix matching the Domain Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

.. _1446_match-type-equals:

match-type-equals
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **equals**

        **Description** Specify exact match for the Domain Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

.. _1446_match-type-axfr:

match-type-axfr
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **axfr-domain**

        **Description** Import the list of domains via zone-transfer

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

    **axfr-ip-address**

        **Description** IP address of the listening DNS server

        **Type:** string

        **Format:** ipv4-address

    **axfr-ipv6-address**

        **Description** IPv6 address of the listening DNS server

        **Type:** string

        **Format:** ipv6-address

    **ip-axfr-port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

        **Default:** 53

    **ip-refresh-intvl**

        **Description** Poll every x minutes to check for an Updated axfr default

        **Type:** number

        **Range:** 30-255

        **Default:** 30

    **ipv6-axfr-port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

        **Default:** 53

    **ipv6-refresh-intvl**

        **Description** Poll every x minutes to check for an Updated axfr default

        **Type:** number

        **Range:** 30-255

        **Default:** 30

.. _1446_domain-name-list:

domain-name-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **domain-name**

        **Description** Domain name to be added to this domain list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **interval**

        **Description** DNS query interval (in minute, default is 10)

        **Type:** number

        **Range:** 1-1440

        **Default:** 10