ip-list¶

Configure ip list

ip-list Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name ip-list-list

Collection URI /axapi/v3/ip-list

Element Name ip-list

Element URI /axapi/v3/ip-list/{name}

Element Attributes ip-list_attributes

Partition Visibility shared

Schema ip-list schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ip-list	ip-list attributes
POST /axapi/v3/ip-list/ Payload: { "ip-list": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/ip-list	ip-list attributes
Get Object	GET	/axapi/v3/ip-list/{name}	ip-list attributes
GET /axapi/v3/ip-list/a Reponse: { "ip-list": { "name": "a", "uuid": "5266c398-501e-11ee-9112-5d2b36fc5797", "user-tag": "a", "a10-url": "/axapi/v3/ip-list/a" } }
Get List	GET	/axapi/v3/ip-list	ip-list-list
Modify Object	POST	/axapi/v3/ip-list/{name}	ip-list attributes
Replace Object	PUT	/axapi/v3/ip-list/{name}	ip-list attributes
PUT /axapi/v3/ip-list/a Payload: { "ip-list": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/ip-list	ip-list-list
Delete Object	DELETE	/axapi/v3/ip-list/{name}	ip-list attributes
DELETE /axapi/v3/ip-list/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

ip-list-list¶

ip-list-list is JSON List of ip-list attributes

ip-list-list : [

{ ip-list attributes },

{ ip-list attributes },

…

]

ip-list attributes¶

ipv4-config

Type: List

ipv6-config

Type: List

ipv6-prefix-config

Type: List

name

Description Specify name of the ip 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

ipv6-config¶

Specification Value

Type list

Block object keys

ipv6-end-addr

Description IPv6 Range End Address

Type: string

Format: ipv6-address

ipv6-start-addr

Description IPv6 Range Start Address / IPv6 Address

Type: string

Format: ipv6-address

ipv4-config¶

Specification Value

Type list

Block object keys

ipv4-end-addr

Description IPv4 Range End Address

Type: string

Format: ipv4-address

ipv4-start-addr

Description IPv4 Range Start Address / IPv4 Address

Type: string

Format: ipv4-address

ipv6-prefix-config¶

Specification Value

Type list

Block object keys

count

Description Number of IPv6 prefixes

Type: number

Range: 1-2147483647

ipv6-addr-prefix

Description IPv6 Prefix Range Start / IPv6 Prefix

Type: string

Format: ipv6-address-plen

ipv6-prefix-to

Description IPv6 Prefix Range End

Type: string

Format: ipv6-address-plen