Contact UsGet started
© 2024 Iron Hive LLC Belgrade

SmartCaptcha API, gRPC: CaptchaService.Get

Written by
Updated at October 17, 2024

Returns the specified Captcha resource.

gRPC request

rpc Get (GetCaptchaRequest) returns (Captcha)

GetCaptchaRequest

{
  "captchaId": "string"
}

Field

Description

captchaId

string

Required field. ID of the Captcha resource to return.

Captcha

{
  "id": "string",
  "folderId": "string",
  "cloudId": "string",
  "clientKey": "string",
  "createdAt": "google.protobuf.Timestamp",
  "name": "string",
  "allowedSites": [
    "string"
  ],
  "complexity": "CaptchaComplexity",
  "styleJson": "string",
  "suspend": "bool",
  "turnOffHostnameCheck": "bool",
  "preCheckType": "CaptchaPreCheckType",
  "challengeType": "CaptchaChallengeType",
  "securityRules": [
    {
      "name": "string",
      "priority": "int64",
      "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": "bool",
  "overrideVariants": [
    {
      "uuid": "string",
      "description": "string",
      "complexity": "CaptchaComplexity",
      "preCheckType": "CaptchaPreCheckType",
      "challengeType": "CaptchaChallengeType"
    }
  ]
}

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

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

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.

  • CAPTCHA_COMPLEXITY_UNSPECIFIED
  • EASY: High chance to pass pre-check and easy advanced challenge.
  • MEDIUM: Medium chance to pass pre-check and normal advanced challenge.
  • HARD: Little chance to pass pre-check and hard advanced challenge.
  • FORCE_HARD: Impossible to pass pre-check and hard advanced challenge.

styleJson

string

JSON with variables to define the captcha appearance. For more details see generated JSON in cloud console.

suspend

bool

Determines that the captcha is currently in restricted mode, see SmartCaptcha restricted mode.

turnOffHostnameCheck

bool

Turn off host name check, see Domain validation.

preCheckType

enum CaptchaPreCheckType

Basic check type of the captcha.

  • CAPTCHA_PRE_CHECK_TYPE_UNSPECIFIED
  • CHECKBOX: User must click the "I am not a robot" button.
  • SLIDER: User must move the slider from left to right.

challengeType

enum CaptchaChallengeType

Additional task type of the captcha.

  • CAPTCHA_CHALLENGE_TYPE_UNSPECIFIED
  • IMAGE_TEXT: Text recognition: The user has to type a distorted text from the picture into a special field.
  • SILHOUETTES: Silhouettes: The user has to mark several icons from the picture in a particular order.
  • KALEIDOSCOPE: Kaleidoscope: The user has to build a picture from individual parts by shuffling them using a slider.

securityRules[]

SecurityRule

List of security rules.

deletionProtection

bool

Determines whether captcha is protected from being deleted.

overrideVariants[]

OverrideVariant

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

int64

Priority of the rule. Lower value means higher priority.

description

string

Optional description of the rule. 0-512 characters long.

condition

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

HostMatcher

Host where captcha placed.

uri

UriMatcher

URI where captcha placed.

headers[]

HeaderMatcher

Captcha request headers.

sourceIp

IpMatcher

The IP address of the requester.

HostMatcher

HostMatcher object.

Field

Description

hosts[]

StringMatcher

List of hosts. OR semantics implied.

StringMatcher

StringMatcher object.

Field

Description

exactMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

exactNotMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

prefixMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

prefixNotMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

pireRegexMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

pireRegexNotMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

UriMatcher

UriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

Field

Description

ipRangesMatch

IpRangesMatcher

ipRangesNotMatch

IpRangesMatcher

geoIpMatch

GeoIpMatcher

geoIpNotMatch

GeoIpMatcher

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.

  • CAPTCHA_COMPLEXITY_UNSPECIFIED
  • EASY: High chance to pass pre-check and easy advanced challenge.
  • MEDIUM: Medium chance to pass pre-check and normal advanced challenge.
  • HARD: Little chance to pass pre-check and hard advanced challenge.
  • FORCE_HARD: Impossible to pass pre-check and hard advanced challenge.

preCheckType

enum CaptchaPreCheckType

Basic check type of the captcha.

  • CAPTCHA_PRE_CHECK_TYPE_UNSPECIFIED
  • CHECKBOX: User must click the "I am not a robot" button.
  • SLIDER: User must move the slider from left to right.

challengeType

enum CaptchaChallengeType

Additional task type of the captcha.

  • CAPTCHA_CHALLENGE_TYPE_UNSPECIFIED
  • IMAGE_TEXT: Text recognition: The user has to type a distorted text from the picture into a special field.
  • SILHOUETTES: Silhouettes: The user has to mark several icons from the picture in a particular order.
  • KALEIDOSCOPE: Kaleidoscope: The user has to build a picture from individual parts by shuffling them using a slider.
Previous
Overview
Next
GetSecretKey