domain-list

Configure Domain classification list

domain-list Specification

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

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

match-type-suffix

Specification  
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-equals

Specification  
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-axfr

Specification  
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

operational data

  Counter Size Description
       
  domain-list   domain-list
  displayed-count number displayed-count
  binding-info flag binding-info
  domain-entries   domain-entries
  domain-list-type string domain-list-type
  domain-list-name-filter string domain-list-name-filter
  match-type string match-type

operational data

  Counter Size Description
       
  config-type enum Output contains one of the following values: - FILE, CLI
  binding-num number binding-num
  displayed-count number displayed-count
  total-entry-num number total-entry-num
  domain-list-name string domain-list-name
  domain-entries   domain-entries
  match-type string match-type