User guides

Quick reference

Below is a summary of the system as a whole.

Account Defender API

Base domain: https://console.humansecurity.com/api/v1/account_defender/account

Account info API

URLHTTP verbDescription
/{account_id}GETAccess the attack status and risk score of an account

Delete user data API

URLHTTP verbDescription
/delete_user_dataPOSTRequest data deletion for specified users

Feedback API

URLHTTP verbDescription
/update_statusPOSTUpdate incidents

Adaptive Feedback API

Base domain: https://api.humansecurity.com/v1/external

URLHTTP verbDescription
/alerts/status/{requestId}GETGet alert status
/alertsPOSTSend an alert

Bot Defender API

Base domain: https://console.humansecurity.com/api/v1/botDefender

Custom lists API

URLHTTP verbDescription
/customListsGETGet all custom lists
/customListsPOSTCreate a custom list
/customLists/{listId}GETGet a list by ID
/customLists/{listId}PATCHUpdate a list by ID

Custom list identifiers API

URLHTTP verbDescription
/customLists/{listId}/identifiersGETGet identifiers from a custom list
/customLists/{listId}/identifiersPOSTAdd identifiers to a custom list
/customLists/{listId}/identifiersPUTReplace identifiers in a custom list with new ones
/customLists/{listId}/identifiersDELRemove all identifiers from a custom list
/customLists/{listId}/identifiers/{identifierId}DELRemove a single identifier from a custom list

Credential Intelligence API

Base domain: https://sapi-{appId}.perimeterx.net/api/v1

Compromised API

URLHTTP verbDescription
/is_compromisedPOSTReceive a report based on credentials

Code Defender API

Base domain: https://api-gw.perimeterx.com/v1

Incidents API

URLHTTP verbDescription
/incidentsGETGet all incidents

Scripts API

URLHTTP verbDescription
/scriptsGETGet all allowed scripts

Allow lists API

URLHTTP verbDescription
/allow-listsGETGet all allowed actions

Deny lists API

URLHTTP verbDescription
/deny-listsGETGet all blocked actions
URLHTTP verbDescription
/cookie-reportGETGet all cookie data

Account settings API

URLHTTP verbDescription
/account-settingsGETGet account settings

PCI DSS API

Base domain: https://api-gw.perimeterx.com/v1/pci

Inventory API

URLHTTP verbDescription
/inventory/scriptsGETGet script inventory
/inventory/headersGETGet header inventory

Status API

URLHTTP verbDescription
/status/scriptsPUTUpdate a script’s status
/status/headersPUTUpdate a header’s status

Audits API

URLHTTP verbDescription
/audits/scriptsGETGet script audits
/audits/headersGETGet header audits