import¶
Get files from remote site
import Specification¶
Parameter Value Type operational Element Name import Element URI /axapi/v3/import Element Attributes import_attributes Partition Visibility shared Schema import schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/import |
import attributes¶
aflex
Description aFleX Script Source File
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-jwks
Description JSON web key
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-portal
Description Portal file for http authentication
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-portal-image
Description Image file for default portal
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-saml-idp
Description: auth-saml-idp is a JSON Block. Please see below for auth-saml-idp
Type: Object
Reference Object: /axapi/v3/import/auth-saml-idp
bios-file
Description BIOS Image file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
bw-list
Description Black white List File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
ca-cert
Description 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
class-list
Description Class List File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
class-list-convert
Description Convert Class List File to A10 format
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
cloud-config
Description Cloud Configuration File
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
cloud-creds
Description Cloud Credentials File
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
dnssec-dnskey
Description DNSSEC DNSKEY(KSK) file for child zone
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
dnssec-ds
Description DNSSEC DS file for child zone
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
geo-location
Description Geo-location CSV File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
glm-cert
Description GLM certificate
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
glm-license
Description License File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
health-external
Description: health-external is a JSON Block. Please see below for health-external
Type: Object
Reference Object: /axapi/v3/import/health-external
health-postfile
Description: health-postfile is a JSON Block. Please see below for health-postfile
Type: Object
Reference Object: /axapi/v3/import/health-postfile
ip-map-list
Description IP Map List File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
local-uri-file
Description Local URI files for http response
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
lw-4o6
Description LW-4over6 Binding Table File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
overwrite
Description Overwrite existing file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description password for the remote site
Type: string
Format: string-rlx
Maximum Length: 128 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
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
Mutual Exclusion: remote-file, terminal, and store-name are mutually exclusive
rpz
Description Response Policy Zone File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
secured
Description Mark as non-exportable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
ssl-cert-key
Description ‘bulk’: import an archive file;
Type: string
Supported Values: bulk
ssl-crl
Description SSL Crl File
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
ssl-key
Description SSL Key File(enter bulk when import an archive file)
Type: string
Format: string-rlx
Maximum Length: 245 characters
Maximum Length: 1 characters
store
Description: store is a JSON Block. Please see below for store
Type: Object
Reference Object: /axapi/v3/import/store
store-name
Description Import store name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: store-name, terminal, and remote-file are mutually exclusive
terminal
Description terminal vi
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: terminal, remote-file, and store-name are mutually exclusive
thales-kmdata
Description Thales Kmdata files
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
thales-secworld
Description Thales security world files
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
to-device
Description: to-device is a JSON Block. Please see below for to-device
Type: Object
Reference Object: /axapi/v3/import/to-device
usb-license
Description USB License File
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
user-tag
Description Customized tag
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
web-category-license
Description License file to enable web-category feature
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
wsdl
Description Web Service Definition Language File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
xml-schema
Description XML-Schema File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
health-external¶
Specification Value Type object description
Description Describe the Program Function briefly
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
externalfilename
Description Specify the Program Name
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
overwrite
Description Overwrite existing file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description password for the remote site
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
remote-file
Description
Type: string
Format: url
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
health-postfile¶
Specification Value Type object overwrite
Description Overwrite existing file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description password for the remote site
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
postfilename
Description Specify the File Name
Type: string
Maximum Length: 31 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
store¶
Specification Value Type object create
Description Create an import store profile
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
delete
Description Delete an import store profile
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description profile name to store remote url
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
remote-file
Description
Type: string
Format: url
to-device¶
Specification Value Type object device
Description Device (Device ID)
Type: number
glm-cert
Description GLM certificate
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
glm-license
Description License File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
overwrite
Description Overwrite existing file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
web-category-license
Description License file to enable web-category feature
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-saml-idp¶
Specification Value Type object overwrite
Description Overwrite existing file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description password for the remote site
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
remote-file
Description Profile name for remote url
Type: string
Format: url
saml-idp-name
Description Metadata name
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
verify-xml-signature
Description Verify metadata’s XML signature
Type: boolean
Supported Values: true, false, 1, 0
Default: 0