.. _import_periodic: import-periodic =============== Get files from remote site periodically import-periodic Specification ----------------------------- ===================================== ======================================================== **Parameter** **Value** ===================================== ======================================================== **Type** *Intermediate Resource* **Element Name** import-periodic **Element URI** /axapi/v3/import-periodic **Element Attributes** import-periodic_attributes **Partition Visibility** shared **Schema** :download:`import-periodic schema ` ===================================== ======================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/import-periodic .. raw:: html import-periodic_attributes .. raw:: html
.. _1893_import-periodic_attributes: import-periodic attributes -------------------------- **aflex-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/aflex/{aflex} ` **auth-jwks-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/auth-jwks/{auth-jwks} ` **auth-portal-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/auth-portal/{auth-portal} ` **bw-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/bw-list/{bw-list} ` **ca-cert-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/ca-cert/{ca-cert} ` **class-list-convert-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/class-list-convert/{class-list-convert} ` **class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/class-list/{class-list} ` **dnssec-dnskey-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/dnssec-dnskey/{dnssec-dnskey} ` **dnssec-ds-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/dnssec-ds/{dnssec-ds} ` **domain-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/domain-list/{domain-list} ` **geo-location-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/geo-location/{geo-location} ` **local-uri-file-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/local-uri-file/{local-uri-file} ` **policy-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/policy/{policy} ` **rpz-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/rpz/{rpz} ` **ssl-cert-key-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/ssl-cert-key/{ssl-cert-key} ` **ssl-cert-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/ssl-cert/{ssl-cert} ` **ssl-crl-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/ssl-crl/{ssl-crl} ` **ssl-key-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/ssl-key/{ssl-key} ` **thales-kmdata-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/thales-kmdata/{thales-kmdata} ` **thales-secworld-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/thales-secworld/{thales-secworld} ` **tsig-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/tsig/{tsig} ` **xml-schema-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/import-periodic/xml-schema/{xml-schema} ` .. _1893_domain-list-list: domain-list-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **domain-list** **Description** Domain List Name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_ssl-cert-list: ssl-cert-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-type** **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; **Type:** string **Supported Values:** pem, der, pfx, p7b **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **pfx-password** **Description** The password for certificate file (pfx type only) **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-cert** **Description** SSL Cert File(enter bulk when import an archive file) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_geo-location-list: geo-location-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-location** **Description** Geo-location CSV File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_rpz-list: rpz-list ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **remote-file-zone-transfer** **Description** profile name for remote url **Type:** string **Format:** url **rpz** **Description** Response Policy Zone File **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **zone-transfer** **Description** 'zone-transfer': zone-transfer; **Type:** string **Supported Values:** zone-transfer .. _1893_class-list-convert-list: class-list-convert-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **class-list-convert** **Description** Class List File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **class-list-type** **Description** 'ac': ac; 'ipv4': ipv4; 'ipv6': ipv6; 'string': string; 'string-case-insensitive': string-case-insensitive; **Type:** string **Supported Values:** ac, ipv4, ipv6, string, string-case-insensitive **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_xml-schema-list: xml-schema-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **xml-schema** **Description** XML-Schema File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1893_aflex-list: aflex-list ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aflex** **Description** aFleX Script Source File **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_dnssec-dnskey-list: dnssec-dnskey-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dnssec-dnskey** **Description** DNSSEC DNSKEY(KSK) file for child zone **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_ssl-cert-key-list: ssl-cert-key-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **secured** **Description** Mark keys as non-exportable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-cert-key** **Description** 'bulk': import an archive file; **Type:** string **Supported Values:** bulk **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_thales-kmdata-list: thales-kmdata-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **overwrite** **Description** Overwrite existing file **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **thales-kmdata** **Description** import Thales Kmdata files - in .tgz format that has all files needed by AX **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_ssl-key-list: ssl-key-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **secured** **Description** Mark as non-exportable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-key** **Description** SSL Key File(enter bulk when import an archive file) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_local-uri-file-list: local-uri-file-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **local-uri-file** **Description** Local URI files for http response **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_class-list-list: class-list-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **background** **Description** background mode for importing class-list **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **class-list** **Description** Class List File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **user-tag** **Description** Customized tag **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_bw-list-list: bw-list-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bw-list** **Description** Black white List File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_ssl-crl-list: ssl-crl-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-crl** **Description** SSL Crl File **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_auth-jwks-list: auth-jwks-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auth-jwks** **Description** JSON web key **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_tsig-list: tsig-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **tsig** **Description** Transaction SIGnatures Key File **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_auth-portal-list: auth-portal-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auth-portal** **Description** Portal file for http authentication **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_policy-list: policy-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **policy** **Description** WAF policy File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_thales-secworld-list: thales-secworld-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **overwrite** **Description** Overwrite existing file **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **thales-secworld** **Description** import Thales security world files - in .tgz format that has all files needed by AX **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_dnssec-ds-list: dnssec-ds-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dnssec-ds** **Description** DNSSEC DS file for child zone **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1893_ca-cert-list: ca-cert-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ca-cert** **Description** SSL CA Cert File(enter bulk when import an archive file) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **certificate-type** **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; **Type:** string **Supported Values:** pem, der, pfx, p7b **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **pfx-password** **Description** The password for certificate file (pfx type only) **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters