slb template captcha instance

CAPTCHA template instance

instance Specification

Parameter

Value

Type

Collection

Object Key(s)

name

Collection Name

instance-list

Collection URI

/axapi/v3/slb/template/captcha/instance

Element Name

instance

Element URI

/axapi/v3/slb/template/captcha/instance/{name}

Element Attributes

instance_attributes

Partition Visibility

shared

Schema

instance schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/slb/template/captcha/instance

instance attributes

Create List

POST

/axapi/v3/slb/template/captcha/instance

instance attributes

Get Object

GET

/axapi/v3/slb/template/captcha/instance/{name}

instance attributes

Get List

GET

/axapi/v3/slb/template/captcha/instance

instance-list

Modify Object

POST

/axapi/v3/slb/template/captcha/instance/{name}

instance attributes

Replace Object

PUT

/axapi/v3/slb/template/captcha/instance/{name}

instance attributes

Replace List

PUT

/axapi/v3/slb/template/captcha/instance

instance-list

Delete Object

DELETE

/axapi/v3/slb/template/captcha/instance/{name}

instance attributes

instance-list

instance-list is JSON List of instance attributes

instance-list : [

instance attributes

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