system path oper¶

Operational Status for the object path

path Specification¶

Parameter Value

Type Collection

Collection Name path-list

Collection URI /axapi/v3/system/path/{l2hm-path-name}

Element Name path

Element URI /axapi/v3/system/path/{l2hm-path-name}/oper

Element Attributes path_attributes

Partition Visibility None

Schema path schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/system/path/{l2hm-path-name}	path attributes
Create List	POST	/axapi/v3/system/path/{l2hm-path-name}	path attributes
Get Object	GET	/axapi/v3/system/path/{l2hm-path-name}/oper	path attributes
Get List	GET	/axapi/v3/system/path/{l2hm-path-name}	path-list
Modify Object	POST	/axapi/v3/system/path/{l2hm-path-name}/oper	path attributes
Replace Object	PUT	/axapi/v3/system/path/{l2hm-path-name}/oper	path attributes
Replace List	PUT	/axapi/v3/system/path/{l2hm-path-name}	path-list
Delete Object	DELETE	/axapi/v3/system/path/{l2hm-path-name}/oper	path attributes

path-list¶

path-list is JSON List of path attributes

path-list : [

{ path attributes },

{ path attributes },

…

]

path attributes¶

l2hm-path-name

Description Monitor Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: hc-obj

oper

Description: oper is a JSON Block. Please see below for oper

Type: Object

oper¶

Specification Value

Type object

path_list

Type: List

oper_path_list¶

Specification Value

Type list

Block object keys

apps

Description

Type: string

endpoint_1

Description

Type: string

endpoint_2

Description

Type: string

health_check

Description

Type: string

l2hm_path

Description

Type: string

path_state

Description

Type: string