domain-list

Configure Domain classification list

domain-list Specification

Parameter

Value

Type

Collection

Object Key(s)

name

Collection Name

domain-list-list

Collection URI

/axapi/v3/domain-list

Element Name

domain-list

Element URI

/axapi/v3/domain-list/{name}

Element Attributes

domain-list_attributes

Partition Visibility

shared

Operational Data URI

/axapi/v3/domain-list/{name}/oper

Schema

domain-list schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/domain-list

domain-list attributes

Create List

POST

/axapi/v3/domain-list

domain-list attributes

Get Object

GET

/axapi/v3/domain-list/{name}

domain-list attributes

Get List

GET

/axapi/v3/domain-list

domain-list-list

Modify Object

POST

/axapi/v3/domain-list/{name}

domain-list attributes

Replace Object

PUT

/axapi/v3/domain-list/{name}

domain-list attributes

Replace List

PUT

/axapi/v3/domain-list

domain-list-list

Delete Object

DELETE

/axapi/v3/domain-list/{name}

domain-list attributes

domain-list-list

domain-list-list is JSON List of domain-list attributes

domain-list-list : [

domain-list attributes

domain-name-list

Type: List

file

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

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

match-type-axfr

Type: List

match-type-equals

Type: List

match-type-suffix

Type: List

name

Description Specify name of the domain list

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

domain-name-list

Specification

Value

Type

list

Block object keys

domain-name

Description Domain name to be added to this domain list

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

fail-interval

Description Set up the failure interval in second for the DNS resolution. (default is 30-second)

Type: number

Range: 3-600

Default: 30

interval

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

Type: number

Range: 1-1440

Default: 10

match-type-equals

Specification

Value

Type

list

Block object keys

equals

Description Specify exact match for the Domain Name

Type: string

Format: string-rlx

Maximum Length: 253 characters

Maximum Length: 1 characters

match-type-suffix

Specification

Value

Type

list

Block object keys

suffix

Description Specify suffix matching the Domain Name

Type: string

Format: string-rlx

Maximum Length: 253 characters

Maximum Length: 1 characters

match-type-axfr

Specification

Value

Type

list

Block object keys

axfr-domain

Description Import the list of domains via zone-transfer

Type: string

Format: string-rlx

Maximum Length: 253 characters

Maximum Length: 1 characters

axfr-ip-address

Description IP address of the listening DNS server

Type: string

Format: ipv4-address

axfr-ipv6-address

Description IPv6 address of the listening DNS server

Type: string

Format: ipv6-address

ip-axfr-port-num

Description Port Number

Type: number

Range: 1-65535

Default: 53

ip-refresh-intvl

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

Type: number

Range: 30-255

Default: 30

ipv6-axfr-port-num

Description Port Number

Type: number

Range: 1-65535

Default: 53

ipv6-refresh-intvl

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

Type: number

Range: 30-255

Default: 30