.. _file: file ==== Local file Mangement file Specification ------------------ ===================================== ============================================= **Parameter** **Value** ===================================== ============================================= **Type** *Intermediate Resource* **Element Name** file **Element URI** /axapi/v3/file **Element Attributes** file_attributes **Partition Visibility** shared **Schema** :download:`file schema ` ===================================== ============================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/file .. raw:: html file_attributes .. raw:: html
.. _1548_file_attributes: file attributes --------------- **aflex** **Description:** aflex is a **JSON Block**. Please see below for :ref:`1548_aflex` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/aflex ` **auth-jwks** **Description:** auth-jwks is a **JSON Block**. Please see below for :ref:`1548_auth-jwks` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/auth-jwks ` **auth-portal** **Description:** auth-portal is a **JSON Block**. Please see below for :ref:`1548_auth-portal` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/auth-portal ` **auth-portal-image** **Description:** auth-portal-image is a **JSON Block**. Please see below for :ref:`1548_auth-portal-image` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/auth-portal-image ` **auth-saml-idp** **Description:** auth-saml-idp is a **JSON Block**. Please see below for :ref:`1548_auth-saml-idp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/auth-saml-idp ` **aws-accesskey** **Description:** aws-accesskey is a **JSON Block**. Please see below for :ref:`1548_aws-accesskey` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/aws-accesskey ` **axdebug-capture** **Description:** axdebug-capture is a **JSON Block**. Please see below for :ref:`1548_axdebug-capture` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/axdebug-capture ` **axdebug-config** **Description:** axdebug-config is a **JSON Block**. Please see below for :ref:`1548_axdebug-config` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/axdebug-config ` **bw-list** **Description:** bw-list is a **JSON Block**. Please see below for :ref:`1548_bw-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/bw-list ` **ca-cert** **Description:** ca-cert is a **JSON Block**. Please see below for :ref:`1548_ca-cert` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ca-cert ` **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`1548_class-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/class-list ` **core** **Description:** core is a **JSON Block**. Please see below for :ref:`1548_core` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/core ` **csr** **Description:** csr is a **JSON Block**. Please see below for :ref:`1548_csr` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/csr ` **debug-monitor** **Description:** debug-monitor is a **JSON Block**. Please see below for :ref:`1548_debug-monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/debug-monitor ` **dnssec-dnskey** **Description:** dnssec-dnskey is a **JSON Block**. Please see below for :ref:`1548_dnssec-dnskey` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/dnssec-dnskey ` **dnssec-ds** **Description:** dnssec-ds is a **JSON Block**. Please see below for :ref:`1548_dnssec-ds` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/dnssec-ds ` **domain-list** **Description:** domain-list is a **JSON Block**. Please see below for :ref:`1548_domain-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/domain-list ` **geo-location** **Description:** geo-location is a **JSON Block**. Please see below for :ref:`1548_geo-location` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/geo-location ` **glm-cert** **Description:** glm-cert is a **JSON Block**. Please see below for :ref:`1548_glm-cert` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/glm-cert ` **glm-license** **Description:** glm-license is a **JSON Block**. Please see below for :ref:`1548_glm-license` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/glm-license ` **health-external** **Description:** health-external is a **JSON Block**. Please see below for :ref:`1548_health-external` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/health-external ` **health-postfile** **Description:** health-postfile is a **JSON Block**. Please see below for :ref:`1548_health-postfile` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/health-postfile ` **license** **Description:** license is a **JSON Block**. Please see below for :ref:`1548_license` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/license ` **local-uri-file** **Description:** local-uri-file is a **JSON Block**. Please see below for :ref:`1548_local-uri-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/local-uri-file ` **log-backup** **Description:** log-backup is a **JSON Block**. Please see below for :ref:`1548_log-backup` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/log-backup ` **ng-waf-module** **Description:** ng-waf-module is a **JSON Block**. Please see below for :ref:`1548_ng-waf-module` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ng-waf-module ` **rpz** **Description:** rpz is a **JSON Block**. Please see below for :ref:`1548_rpz` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/rpz ` **ssh-pubkey** **Description:** ssh-pubkey is a **JSON Block**. Please see below for :ref:`1548_ssh-pubkey` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ssh-pubkey ` **ssl-cert** **Description:** ssl-cert is a **JSON Block**. Please see below for :ref:`1548_ssl-cert` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ssl-cert ` **ssl-cert-key** **Description:** ssl-cert-key is a **JSON Block**. Please see below for :ref:`1548_ssl-cert-key` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ssl-cert-key ` **ssl-cert-poc** **Description:** ssl-cert-poc is a **JSON Block**. Please see below for :ref:`1548_ssl-cert-poc` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ssl-cert-poc ` **ssl-crl** **Description:** ssl-crl is a **JSON Block**. Please see below for :ref:`1548_ssl-crl` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ssl-crl ` **ssl-key** **Description:** ssl-key is a **JSON Block**. Please see below for :ref:`1548_ssl-key` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/ssl-key ` **startup-config** **Description:** startup-config is a **JSON Block**. Please see below for :ref:`1548_startup-config` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/startup-config ` **syslog** **Description:** syslog is a **JSON Block**. Please see below for :ref:`1548_syslog` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/syslog ` **system-backup** **Description:** system-backup is a **JSON Block**. Please see below for :ref:`1548_system-backup` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/system-backup ` **techsupport** **Description:** techsupport is a **JSON Block**. Please see below for :ref:`1548_techsupport` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/techsupport ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1548_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/template ` **tsig** **Description:** tsig is a **JSON Block**. Please see below for :ref:`1548_tsig` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/tsig ` **waf** **Description:** waf is a **JSON Block**. Please see below for :ref:`1548_waf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/waf ` **web-category-license** **Description:** web-category-license is a **JSON Block**. Please see below for :ref:`1548_web-category-license` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/web-category-license ` **web-service-cert-key** **Description:** web-service-cert-key is a **JSON Block**. Please see below for :ref:`1548_web-service-cert-key` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/web-service-cert-key ` **xml-schema** **Description:** xml-schema is a **JSON Block**. Please see below for :ref:`1548_xml-schema` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/xml-schema ` .. _1548_geo-location: geo-location ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** geo-location database local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **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 .. _1548_domain-list: domain-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 32 characters **Maximum Length:** 1 characters **file** **Description** domain list local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **size** **Description** domain list file size in byte **Type:** number **Range:** 0-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_ssl-cert-key: ssl-cert-key ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'replace': replace; **Type:** string **Supported Values:** create, import, export, replace **file** **Description** ssl certificate local file name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 300 characters **Maximum Length:** 1 characters **secured** **Description** Mark keys as non-exportable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1548_bw-list: bw-list ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'check': check; 'create': create; 'delete': delete; 'export': export; 'import': import; 'replace': replace; **Type:** string **Supported Values:** check, create, delete, export, import, replace **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** bw-list file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_rpz: rpz ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; 'export': export; 'check': check; 'delete': delete; 'replace': replace; **Type:** string **Supported Values:** import, export, check, delete, replace **device** **Description** Device (Device ID) **Type:** number **file** **Description** RPZ file name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_aws-accesskey: aws-accesskey ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **user** **Description** user name of the pub key **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_tsig: tsig ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; 'export': export; 'check': check; 'delete': delete; 'replace': replace; **Type:** string **Supported Values:** import, export, check, delete, replace **device** **Description** Device (Device ID) **Type:** number **file** **Description** TSIG file name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_syslog: syslog ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'export': export; **Type:** string **Supported Values:** export **file** **Description** syslog local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_axdebug-config: axdebug-config ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'export': export; 'delete': delete; **Type:** string **Supported Values:** export, delete **file** **Description** axdebug local config file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_auth-portal: auth-portal ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** Destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** Authentication portal local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** Full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_auth-jwks: auth-jwks ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, copy, rename, check, replace, delete **dst-file** **Description** Destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** JWK local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** Full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_aflex: aflex ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** aflex local file name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **skip-backup** **Description** Skip backup logic **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 .. _1548_health-postfile: health-postfile ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 32 characters **Maximum Length:** 1 characters **file** **Description** Specify the File Name **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_ssh-pubkey: ssh-pubkey ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **user** **Description** user name of the pub key **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_web-category-license: web-category-license ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; **Type:** string **Supported Values:** import **device** **Description** Device (Device ID) **Type:** number **file** **Description** Web-Category license local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** Full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **use-mgmt-port** **Description** Enable management port for backend **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1548_log-backup: log-backup ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** all log **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **date** **Description** specify number of days **Type:** number **Range:** 1-31 **day** **Description** Most recent day **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **expedite** **Description** Expedite the Backup **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **month** **Description** Most recent month **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **period** **Description** Specify backup period **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stats-data** **Description** Backup web statistical data **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **week** **Description** Most recent week **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1548_waf: waf ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_ssl-crl: ssl-crl ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, replace, delete **file** **Description** ssl crl local file name **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 300 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_debug-monitor: debug-monitor ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'export': export; **Type:** string **Supported Values:** export **file** **Description** debug monitor local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_web-service-cert-key: web-service-cert-key ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_axdebug-capture: axdebug-capture ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'delete': delete; **Type:** string **Supported Values:** delete **file** **Description** axdebug local capture file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_ssl-cert-poc: ssl-cert-poc ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **certificate-type** **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; **Type:** string **Supported Values:** pem, der, pfx, p7b **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file** **Description** ssl certificate local file name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file-handle** **Description** public-key **Type:** string **Format:** string-rlx **Maximum Length:** 2048 characters **Maximum Length:** 1 characters **pfx-password** **Description** The password for certificate file (pfx type only) **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1548_csr: csr ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'export': export; **Type:** string **Supported Values:** export **file** **Description** Specify the File Name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 300 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_auth-portal-image: auth-portal-image ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** Destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** Authentication portal image local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** Full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_core: core ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'export': export; 'delete': delete; **Type:** string **Supported Values:** export, delete **file** **Description** local core file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **slot** **Description** specify slot id in chassis **Type:** number **Range:** 0-1 .. _1548_ng-waf-module: ng-waf-module ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; 'replace': replace; **Type:** string **Supported Values:** import, replace **file** **Description** NG WAF module local file name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_template: template ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **act-type** **Description** Specify ACT package type (i.e. slug/destination name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **app** **Description:** app is a **JSON Block**. Please see below for :ref:`1548_template_app` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/template/app ` **dst-file** **Description** destination file name for copy and rename action **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** aflex local file name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_template_app: template_app ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **act-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **action** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **version** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1548_class-list: class-list ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** class list local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **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 .. _1548_glm-license: glm-license ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; **Type:** string **Supported Values:** import **device** **Description** Device (Device ID) **Type:** number **file** **Description** glm license local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_dnssec-ds: dnssec-ds ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; 'export': export; **Type:** string **Supported Values:** import, export **file** **Description** dnssec ds local file name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_local-uri-file: local-uri-file ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** local uri file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_ssl-key: ssl-key ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'replace': replace; **Type:** string **Supported Values:** create, import, export, replace **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file** **Description** ssl key local file name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 300 characters **Maximum Length:** 1 characters **secured** **Description** Mark as non-exportable **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 .. _1548_license: license ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **device** **Description** Device (Device ID) **Type:** number **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** license local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_ca-cert: ca-cert ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'replace': replace; **Type:** string **Supported Values:** create, import, export, replace **certificate-type** **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; **Type:** string **Supported Values:** pem, der, pfx, p7b **file** **Description** ssl ca certificate local file name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 300 characters **Maximum Length:** 1 characters **pfx-password** **Description** The password for certificate file (pfx type only) **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **pfx-password-export** **Description** The password for exported certificate file (pfx type only) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_glm-cert: glm-cert ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; **Type:** string **Supported Values:** import **device** **Description** Device (Device ID) **Type:** number **file** **Description** glm license local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_system-backup: system-backup ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _1548_techsupport: techsupport ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'check': check; 'delete': delete; 'export': export; **Type:** string **Supported Values:** create, check, delete, export **file** **Description** techsupport local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **slot** **Description** specify slot id in chassis **Type:** number **Range:** 0-1 **status** **Description:** status is a **JSON Block**. Please see below for :ref:`1548_techsupport_status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/file/techsupport/status ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_techsupport_status: techsupport_status ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_xml-schema: xml-schema ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** XML-schema local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_startup-config: startup-config ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'import': import; **Type:** string **Supported Values:** import **file** **Description** startup-config local file name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_auth-saml-idp: auth-saml-idp ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** Destination file name for copy and rename action **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file** **Description** SAML metadata local file name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **file-handle** **Description** Full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **verify-xml-signature** **Description** Verify metadata's XML signature **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1548_ssl-cert: ssl-cert ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'replace': replace; **Type:** string **Supported Values:** create, import, export, replace **certificate-type** **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; **Type:** string **Supported Values:** pem, der, pfx, p7b **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file** **Description** ssl certificate local file name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 300 characters **Maximum Length:** 1 characters **pfx-password** **Description** The password for certificate file (pfx type only) **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **pfx-password-export** **Description** The password for exported certificate file (pfx type only) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_dnssec-dnskey: dnssec-dnskey ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **file** **Description** dnssec dnskey local file name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1548_health-external: health-external ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; **Type:** string **Supported Values:** create, import, export, copy, rename, check, replace, delete **description** **Description** Describe the Program Function briefly **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dst-file** **Description** destination file name for copy and rename action **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **file** **Description** Specify the Program Name **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **file-handle** **Description** full path of the uploaded file **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters