SmartCaptcha API, REST: Captcha.Get
Returns the specified Captcha resource.
HTTP request
GET https://smartcaptcha.api.cloud.yandex.net/smartcaptcha/v1/captchas/{captchaId}
Path parameters
|
Field |
Description |
|
captchaId |
string Required field. ID of the Captcha resource to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"cloudId": "string",
"clientKey": "string",
"createdAt": "string",
"name": "string",
"allowedSites": [
"string"
],
"complexity": "string",
"styleJson": "string",
"suspend": "boolean",
"turnOffHostnameCheck": "boolean",
"preCheckType": "string",
"challengeType": "string",
"securityRules": [
{
"name": "string",
"priority": "string",
"description": "string",
"condition": {
"host": {
"hosts": [
{
// Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string"
// end of the list of possible fields
}
]
},
"uri": {
"path": {
// Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string"
// end of the list of possible fields
},
"queries": [
{
"key": "string",
"value": {
// Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string"
// end of the list of possible fields
}
}
]
},
"headers": [
{
"name": "string",
"value": {
// Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string"
// end of the list of possible fields
}
}
],
"sourceIp": {
"ipRangesMatch": {
"ipRanges": [
"string"
]
},
"ipRangesNotMatch": {
"ipRanges": [
"string"
]
},
"geoIpMatch": {
"locations": [
"string"
]
},
"geoIpNotMatch": {
"locations": [
"string"
]
}
}
},
"overrideVariantUuid": "string"
}
],
"deletionProtection": "boolean",
"overrideVariants": [
{
"uuid": "string",
"description": "string",
"complexity": "string",
"preCheckType": "string",
"challengeType": "string"
}
]
}
A Captcha resource.
|
Field |
Description |
|
id |
string ID of the captcha. |
|
folderId |
string ID of the folder that the captcha belongs to. |
|
cloudId |
string ID of the cloud that the captcha belongs to. |
|
clientKey |
string Client key of the captcha, see CAPTCHA keys. |
|
createdAt |
string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
name |
string Name of the captcha. The name is unique within the folder. 3-63 characters long. |
|
allowedSites[] |
string List of allowed host names, see Domain validation. |
|
complexity |
enum (CaptchaComplexity) Complexity of the captcha.
|
|
styleJson |
string JSON with variables to define the captcha appearance. For more details see generated JSON in cloud console. |
|
suspend |
boolean Determines that the captcha is currently in restricted mode, see SmartCaptcha restricted mode. |
|
turnOffHostnameCheck |
boolean Turn off host name check, see Domain validation. |
|
preCheckType |
enum (CaptchaPreCheckType) Basic check type of the captcha.
|
|
challengeType |
enum (CaptchaChallengeType) Additional task type of the captcha.
|
|
securityRules[] |
List of security rules. |
|
deletionProtection |
boolean Determines whether captcha is protected from being deleted. |
|
overrideVariants[] |
List of variants to use in security_rules |
SecurityRule
SecurityRule object. Defines the condition and action: when and which variant to show.
|
Field |
Description |
|
name |
string Required field. Name of the rule. The name is unique within the captcha. 1-50 characters long. |
|
priority |
string (int64) Priority of the rule. Lower value means higher priority. |
|
description |
string Optional description of the rule. 0-512 characters long. |
|
condition |
The condition for matching the rule. |
|
overrideVariantUuid |
string Variant UUID to show in case of match the rule. Keep empty to use defaults. |
Condition
Condition object. AND semantics implied.
|
Field |
Description |
|
host |
Host where captcha placed. |
|
uri |
URI where captcha placed. |
|
headers[] |
Captcha request headers. |
|
sourceIp |
The IP address of the requester. |
HostMatcher
HostMatcher object.
|
Field |
Description |
|
hosts[] |
List of hosts. OR semantics implied. |
StringMatcher
StringMatcher object.
|
Field |
Description |
|
exactMatch |
string Includes only one of the fields |
|
exactNotMatch |
string Includes only one of the fields |
|
prefixMatch |
string Includes only one of the fields |
|
prefixNotMatch |
string Includes only one of the fields |
|
pireRegexMatch |
string Includes only one of the fields |
|
pireRegexNotMatch |
string Includes only one of the fields |
UriMatcher
UriMatcher object. AND semantics implied.
|
Field |
Description |
|
path |
Path of the URI RFC3986. |
|
queries[] |
List of query matchers. AND semantics implied. |
QueryMatcher
QueryMatcher object.
|
Field |
Description |
|
key |
string Required field. Key of the query parameter. |
|
value |
Required field. Value of the query parameter. |
HeaderMatcher
HeaderMatcher object.
|
Field |
Description |
|
name |
string Required field. Name of header (case insensitive). |
|
value |
Required field. Value of the header. |
IpMatcher
IpMatcher object. AND semantics implied.
|
Field |
Description |
|
ipRangesMatch |
|
|
ipRangesNotMatch |
|
|
geoIpMatch |
|
|
geoIpNotMatch |
IpRangesMatcher
IpRangesMatcher object.
|
Field |
Description |
|
ipRanges[] |
string List of IP ranges. OR semantics implied. |
GeoIpMatcher
GeoIpMatcher object.
|
Field |
Description |
|
locations[] |
string ISO 3166-1 alpha 2. OR semantics implied. |
OverrideVariant
OverrideVariant object. Contains the settings to override.
|
Field |
Description |
|
uuid |
string Unique identifier of the variant. |
|
description |
string Optional description of the rule. 0-512 characters long. |
|
complexity |
enum (CaptchaComplexity) Complexity of the captcha.
|
|
preCheckType |
enum (CaptchaPreCheckType) Basic check type of the captcha.
|
|
challengeType |
enum (CaptchaChallengeType) Additional task type of the captcha.
|