{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Challenge actions API", "version": "2" }, "items": [ { "info": { "name": "Challenge actions", "type": "folder" }, "items": [ { "info": { "name": "List challenge actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/response-actions/challenge-actions", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "List all of your challenge actions along with their names, challenge types, and other summary information." }, { "info": { "name": "Create a challenge action", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/response-actions/challenge-actions", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new challenge action. Use this action type to insert a challenge, like a CAPTCHA, into the user workflow. You can also apply your own branding to the action to match your website. See [Challenge actions](https://techdocs.akamai.com/app-api-protector/docs/challenge-actions) for more details." }, { "info": { "name": "Get a challenge action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "name": "accountSwitchKey", "value": "", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details about the specified challenge action." }, { "info": { "name": "Update a challenge action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "name": "accountSwitchKey", "value": "", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit the specified challenge action, such as the name, type of challenge, or branding." }, { "info": { "name": "Delete a challenge action", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "name": "accountSwitchKey", "value": "", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Remove the specified challenge action." }, { "info": { "name": "Update Google reCAPTCHA secret key", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId/google-recaptcha-secret-key", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "name": "accountSwitchKey", "value": "", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Specify a different Google reCAPTCHA secret key for a challenge action. The secret key authorizes communication between your site and the reCAPTCHA server." } ] } ], "bundled": true }