For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HUMAN DashboardHUMAN WebsiteRequest a Demo
Product GuidesEnforcer GuidesMobile SDKAPI ReferenceCustomer support
Product GuidesEnforcer GuidesMobile SDKAPI ReferenceCustomer support
  • User guides
    • About the Applications API
    • Getting started
    • Authentication
    • Quick reference
  • Account Defender API
  • Bot Defender API
  • Credential Intelligence API
  • Code Defender API
    • Code Examples
  • Enforce API
  • PCI DSS API
LogoLogo
Login
Login
HUMAN DashboardHUMAN WebsiteRequest a Demo
On this page
  • Account Defender API
  • Account info API
  • Delete user data API
  • Feedback API
  • Account info API
  • Bot Defender API
  • Custom lists API
  • Custom list identifiers API
  • Custom rules API
  • Credential Intelligence API
  • Compromised API
  • Code Defender API
  • Incidents API
  • Scripts API
  • Allow lists API
  • Deny lists API
  • Cookie report API
  • Account settings API
  • PCI DSS API
  • Inventory API
  • Status API
  • Audits API
User guides

Quick reference

Was this page helpful?
Previous

Get account info v1

Next
Built with

Below is a summary of the system as a whole.

Account Defender API

v1
v2

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

Bot Defender API

v1
v2

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

Cookie report API

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