slb template captcha

CAPTCHA template

captcha Specification

Parameter	Value
Type	Configuration Resource
Element Name	captcha
Element URI	/axapi/v3/slb/template/captcha
Element Attributes	captcha_attributes
Partition Visibility	shared
Schema	captcha schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/captcha	captcha attributes	example close
POST /axapi/v3/slb/template/captcha Payload: { "captcha": { "instance-list": [ { "name": "a", "default-captcha": 1, "captcha-type": "reCAPTCHAv2-checkbox", "site-key-string": "a" } ] } }
Get Object	GET	/axapi/v3/slb/template/captcha	captcha attributes	example close
GET /axapi/v3/slb/template/captcha Reponse: { "captcha": { "instance-list": [ { "name": "a", "default-captcha": 1, "captcha-type": "reCAPTCHAv2-checkbox", "site-key-encrypted": "AzM5OFl7RPpSy9SOrqFc/hDpane0qHcTRIb4Uov9JKMDySFDYFUlKaZg9pVrkF3J", "secret-key": 0, "method": "POST", "timeout": 10, "send-client-ip": 0, "uuid": "517085f2-c406-11db-ab88-bf0e97deb7fe", "a10-url": "/axapi/v3/slb/template/captcha/instance/a" } ], "a10-url": "/axapi/v3/slb/template/captcha" } }
Modify Object	POST	/axapi/v3/slb/template/captcha	captcha attributes
Replace Object	PUT	/axapi/v3/slb/template/captcha	captcha attributes
Delete Object	DELETE	/axapi/v3/slb/template/captcha	captcha attributes	example close
DELETE /axapi/v3/slb/template/captcha Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

captcha attributes

instance-list

Type: List

Reference Object: /axapi/v3/slb/template/captcha/instance/{name}

instance-list

Specification	Value
Type	list
Block object keys

captcha-type

Description ‘reCAPTCHAv2-checkbox’: Google reCAPTCHAv2 Checkbox; ‘reCAPTCHAv2-invisible’: Google reCAPTCHAv2 Invisible; ‘reCAPTCHAv3’: Google reCAPTCHAv3;

Type: string

Supported Values: reCAPTCHAv2-checkbox, reCAPTCHAv2-invisible, reCAPTCHAv3

client-ip-param-name

Description Specify client ip parameter name (Set parameter name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

default-captcha

Description Specify the default CAPTCHA service

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

method

Description ‘POST’: Uses POST method; ‘GET’: Uses GET method;

Type: string

Supported Values: POST, GET

Default: POST

name

Description Specify captcha template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

resp-error-code-field-name

Description Specify error code field name used in JSON response (Set field name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

resp-result-field-name

Description Specify the result field name used in JSON response (Set field name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

secret-key

Description Specify the secret key

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secret-key-encrypted

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

secret-key-param-name

Description Specify secret key parameter name (Set parameter name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

secret-key-string

Description Secret key string

Type: string

Format: password

Maximum Length: 127 characters

Maximum Length: 1 characters

send-client-ip

Description Send the client IP address if client IP is required in the verification

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

site-key-encrypted

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

site-key-string

Description Site key string

Type: string

Format: password

Maximum Length: 127 characters

Maximum Length: 1 characters

timeout

Description Specify the timeout time (Specify timeout value, default is 10 seconds)

Type: number

Range: 1-255

Default: 10

token-param-name

Description Specify CAPTCHA token parameter name (Set parameter name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

url

Description Specify the server URL for verifying the CAPTCHA token, default scheme is https

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