Incapsula API Reference

API reference for the Hyper Solutions Incapsula API: generate reese84 sensor payloads and utmvc cookies for sites behind Imperva / Incapsula.

Tip: Use one of the SDKs instead of directly calling the API.

This API generates human-like data based on the most recent chrome browser version on Windows. It is recommended to match the latest TLS fingerprint and UserAgent of the newest chrome version when using this API on a site. The latest chrome useragents can be found here. It is perfectly fine to use only one useragent for all your requests. Note that all request payloads to this API should be sent as application/json.

Generate reese84 sensor

Generate reese84 sensor

post

Generates sensor data that should be posted in order to acquire valid "reese84" cookies

Header parameters

Content-Typestring · enumRequired

The Content-Type of the request body

Possible values:

x-api-keystringRequired

Your API key for authentication

Body

userAgentstringRequired

The userAgent that you're using for the entire session

pageUrlstringRequired

Your page URL.

scriptstringRequired

The script content as a string.

scriptUrlstringRequired

The script url where you got the script contents from.

ipstringRequired

The IP that is used to post the sensor data to the target site. You can use /ip to get the IP from a connection. If you are not using proxies, this will be the IPv4 or IPv6 address of your pc.

acceptLanguagestringRequired

Your accept-language header.

powstringOptional

The pow string fetched from incapsula resource.

Responses

200

OK Sensor data successfully generated

application/json

payloadstringOptional

The generated sensor data

400

Bad Request Error occurred

application/json

403

Forbidden Authentication error

application/json

{
  "payload": "text"
}

Generate utmvc cookie

Since the request body of the requests will be large, it is highly recommended to apply compression to your request body first. We support the following compression methods: "gzip", "br", "deflate", and "zstd".

Don't forget to set the content-encoding header.

Generate utmvc cookie

post

Generates a utmvc cookie

Header parameters

Content-Typestring · enumRequired

The Content-Type of the request body

Possible values:

x-api-keystringRequired

Your API key for authentication

content-encodingstringOptional

In case you want to improve latency to our APIs, you can apply encoding to your request payload and set the content-encoding header accordingly.

Body

scriptstringRequired

The JavaScript obtained from doing a GET request to the script path.

sessionIdsstring[]Required

The value of each cookie that has a name that starts with incap_ses_.

userAgentstringRequired

The userAgent that you're using for your whole session.

Responses

200

OK Cookie was generated

application/json

payloadstringOptional

The generated cookie value

swhanedlstringOptional

Parameters for /_Incapsula_Resource?SWHANEDL= request

400

Bad Request Error occurred

application/json

403

Forbidden Authentication error

application/json

{
  "payload": "text",
  "swhanedl": "text"
}