health monitor method pop3¶

POP3 type

pop3 Specification¶

Parameter Value

Type Configuration Resource

Element Name pop3

Element URI /axapi/v3/health/monitor/{name}/method/pop3

Element Attributes pop3_attributes

Partition Visibility shared

Schema pop3 schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/pop3	pop3 attributes
POST /axapi/v3/health/monitor/a/method/pop3 Payload: { "pop3": { "pop3": 1, "pop3-password": 1, "pop3-username": "a", "pop3-password-string": "a" } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/pop3	pop3 attributes
GET /axapi/v3/health/monitor/a/method/pop3 Reponse: { "pop3": { "pop3": 1, "pop3-username": "a", "pop3-password": 1, "pop3-encrypted": "SjdsynDgUwEKGqDhZaNI3DH9T+TOD+PA67vrwyPgTU1Wpuz9zEzpX7RGR/mcFDHQ", "pop3-port": 110, "uuid": "0a653762-4fcb-11ee-8c93-17f0fbeb6d81", "a10-url": "/axapi/v3/health/monitor/a/method/pop3" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/pop3	pop3 attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/pop3	pop3 attributes
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/pop3	pop3 attributes
DELETE /axapi/v3/health/monitor/a/method/pop3 Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

pop3 attributes¶

pop3

Description POP3 type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pop3-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

pop3-password

Description Specify the user password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pop3-password-string

Description Specify the user password, ‘’ means empty password

Type: string

Format: password

Maximum Length: 31 characters

Maximum Length: 1 characters

pop3-port

Description Specify the POP3 port, default is 110 (Port Number (default 110))

Type: number

Range: 1-65534

Default: 110

pop3-username

Description Specify the username

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters