Score Profile API


Use the Score Profile API to get either a JSON or CSV of risk hit scoring for a specific API key.

API Endpoint (5.21)

The API accepts both HTTPS POST and HTTPS GET.

For GET use the format:

When using POST, make sure to have Content-Type: application/x-www-form-urlencoded

CURL POST API call example:

$ curl -X POST -H Content-Type:application/x-www-form-urlencoded -d 'apikey=your_apikey'

Format Options

Add format option to select either json (default) or csv

For example, a JSON report using CURL:

$ curl -X POST -H Content-Type:application/x-www-form-urlencoded -d 'apikey=your_apikey'

Or using GET to generate a CSV file:


The response JSON contains the account and API key name in the E-HAWK Score Profile array. The hits array lists, by area, all possible hits, default scores, a description of the test, current score, last updated (if updated then user data and timestamp is appended). An example format is:

Status Codes

Status Response
200 OK (no errors)
502 Invalid APIKEY or URL
-6 IP not in ACL