Enforce an HTTP request
Processes an HTTP request and returns an enforcement response.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
request
The HTTP request that should be enforced.
additional
Any additional data to consider while processing the HTTP request.
Response
success
status
Whether the Enforce API call was successful. 0 for success, -1 for failure.
Allowed values:
score
The risk score associated with the request on a scale of 0-100, where 0 is not a bot and 100 is a bot.
action
The type of block response that should be returned to the end user. See Possible values:
c: Captcha. See HUMAN Challenge for details.b: Hard block. See Create custom Traffic policy rules for details.r: Rate limit. See Traffic policy settings for details.a: Allow.
Allowed values:
pxhd
A hashed data value that should be set on the returned response as the _pxhd cookie
uuid
The unique ID associated with the web interaction this request was a part of.
vid
The unique ID associated with the user who sent the request if known.
data_enrichment
A data enrichment object with additioanl information about the detection that was performed on the request. See Data classification enrichment for details. In the scope of the integration, the most relevant fields are:
cgp: Holds a value of 1 once a Challenge is successfully solved for the configured grace period. This defaults to 15 minutes and can be changed upon request. If a challenge is not solved, if the grace period passes, or if the request was reidentified as a bot (such as going above the request volume threshold), thecgpflag will be empty or have a value of 0. If the request was reidentified as a bot, the score and action will also be updated accordingly.bm: Holds a value of 1 if the request is in bypass mode. If the traffic is not in bypass mode, the field won’t be a part of the data enrichment. Therefore, eitherbm: 1appears if bypass mode is enabled, or it will not appear at all.
Errors
400
Bad Request Error
401
Unauthorized Error
415
Unsupported Media Type Error
