Get a challenge action

get https://{hostname}/appsec/v1/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions/{actionId}

View details about the specified challenge action.

Responses

Response body

object

actionId

string

Read-only Identifies the action.

actionName

string

required

length between 1 and 100

The action's unique name.

allowFullCpuUtilization

boolean | null

Set to true to let the client use 100 percent CPU to resolve the challenge. If more humans than bots see this challenge, set to false.

challengeIntervalInSeconds

integer

required

1 to 7200

Time between challenges. Set according to how long users interact with the resource you're protecting. A short period interrupts users more often.

challengeType

string

required

Specify the type of challenge. Choose GOOGLE_RECAPTCHA to make users solve a CAPTCHA puzzle. You can also choose AKAMAI_WEB_CRYPTO or AKAMAI_MOBILE_CRYPTO to make web requesting clients or mobile requesting clients solve a proof-of-work cryptographic challenge.

GOOGLE_RECAPTCHA AKAMAI_WEB_CRYPTO AKAMAI_MOBILE_CRYPTO

cryptoChallengeDurationInSeconds

integer | null

≤ 120

Specify how many seconds the client machine should spend on the challenge. The longer the duration, the more difficult the challenge.

customBrandingLegacyCssUrl

string | null

The CSS page containing your custom spinner. Specify the page's fully qualified URL or root-relative path, like http://example.com/pages/sample.html or /pages/sample.html.

customBrandingLegacyMessageUrl

string | null

The web page containing the static HTML snippet with your custom message. Specify the page's fully qualified URL or root-relative path, like http://example.com/pages/sample.html or /pages/sample.html.

customBrandingUrl

string | null

The web page containing the static HTML snippet with your custom logo. Specify the page's fully qualified URL or root-relative path, like http://example.com/pages/sample.html or /pages/sample.html.

description

string | null

An optional description of the action.

googleReCaptchaSecretKey

string | null

If the challengeType is GOOGLE_RECAPTCHA, specify the Google reCAPTCHA secret key. The secret key authorizes communication between your site and the reCAPTCHA server.

googleReCaptchaSiteKey

string | null

If the challengeType is GOOGLE_RECAPTCHA, specify the Google reCAPTCHA site key. The site key invokes the reCAPTCHA service on your site or application.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/appsec/v1/configs/configId/versions/versionNumber/response-actions/challenge-actions/actionId \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "actionId": "challenge_108949",
3
  "actionName": "new challenge 4",
4
  "allowFullCpuUtilization": true,
5
  "challengeIntervalInSeconds": 723,
6
  "challengeType": "AKAMAI_WEB_CRYPTO",
7
  "cryptoChallengeDurationInSeconds": 100,
8
  "customBrandingUrl": "/abcd.html"
9
}

200Successful response.

403You don't have permission to access the resource.

404The resource doesn't exist.