Update a challenge action

put

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

Edit the specified challenge action, such as the name, type of challenge, or branding.

Path Params

configId

int64

required

A unique identifier for each configuration.

versionNumber

integer

required

A unique identifier for each version of a configuration.

actionId

string

required

Identifies the action.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

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

enum

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.

Allowed:

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response.

400The request body has invalid fields.

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

404The requested challenge action was not found.