> This page is for Applications Protection.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.humansecurity.com/llms.txt.

# Quick reference

Below is a summary of the system as a whole.

## Account Defender API

#### v1

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

### Account info API

| URL             | HTTP verb | Description                                                                                          |
| :-------------- | :-------- | :--------------------------------------------------------------------------------------------------- |
| `/{account_id}` | `GET`     | [Access the attack status and risk score of an account](/applications/reference/get-account-infov-1) |

### Delete user data API

| URL                 | HTTP verb | Description                                                                              |
| :------------------ | :-------- | :--------------------------------------------------------------------------------------- |
| `/delete_user_data` | `POST`    | [Request data deletion for specified users](/applications/reference/delete-user-datav-1) |

### Feedback API

| URL              | HTTP verb | Description                                                 |
| :--------------- | :-------- | :---------------------------------------------------------- |
| `/update_status` | `POST`    | [Update incidents](/applications/reference/upload-feedback) |

#### v2

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

### Account info API

| URL             | HTTP verb | Description                                                                                         |
| :-------------- | :-------- | :-------------------------------------------------------------------------------------------------- |
| `/{account_id}` | `GET`     | [Access the attack status and risk score of an account](/applications/reference/get-account-info-2) |

## Bot Defender API

#### v1

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

### Custom lists API

| URL                     | HTTP verb | Description                                                        |
| :---------------------- | :-------- | :----------------------------------------------------------------- |
| `/customLists`          | `GET`     | [Get all custom lists](/applications/reference/get-custom-lists)   |
| `/customLists`          | `POST`    | [Create a custom list](/applications/reference/create-custom-list) |
| `/customLists/{listId}` | `GET`     | [Get a list by ID](/applications/reference/get-custom-list)        |
| `/customLists/{listId}` | `PATCH`   | [Update a list by ID](/applications/reference/patch-custom-list)   |

### Custom list identifiers API

| URL                                                | HTTP verb | Description                                                                                                   |
| :------------------------------------------------- | :-------- | :------------------------------------------------------------------------------------------------------------ |
| `/customLists/{listId}/identifiers`                | `GET`     | [Get identifiers from a custom list](/applications/reference/get-custom-list-identifiers)                     |
| `/customLists/{listId}/identifiers`                | `POST`    | [Add identifiers to a custom list](/applications/reference/create-custom-list-identifiers)                    |
| `/customLists/{listId}/identifiers`                | `PUT`     | [Replace identifiers in a custom list with new ones](/applications/reference/replace-custom-list-identifiers) |
| `/customLists/{listId}/identifiers`                | `DEL`     | [Remove all identifiers from a custom list](/applications/reference/delete-all-custom-list-identifiers)       |
| `/customLists/{listId}/identifiers/{identifierId}` | `DEL`     | [Remove a single identifier from a custom list](/applications/reference/delete-custom-list-identifier)        |

#### v2

Base domain: `https://console.humansecurity.com/api/v2/botDefender`

### Custom rules API

| URL                     | HTTP verb | Description                                                                    |
| :---------------------- | :-------- | :----------------------------------------------------------------------------- |
| `/customRules`          | `GET`     | [Get all custom rules](/applications/reference/get-custom-rules)               |
| `/customRules`          | `POST`    | [Create a custom rule](/applications/reference/create-custom-rule)             |
| `/customRules/{ruleId}` | `GET`     | [Get a rule by ID](/applications/reference/get-rule-by-id)                     |
| `/customRules/{ruleId}` | `PUT`     | [Update a rule by ID](/applications/reference/update-rule-by-id)               |
| `/customRules/{ruleID}` | `PATCH`   | [Update a rule's field by ID](/applications/reference/update-field-by-rule-id) |
| `/customRules/{ruleID}` | `DELETE`  | [Delete a rule by ID](/applications/reference/delete-rule-by-id)               |

## Credential Intelligence API

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

### Compromised API

| URL               | HTTP verb | Description                                                                         |
| :---------------- | :-------- | :---------------------------------------------------------------------------------- |
| `/is_compromised` | `POST`    | [Receive a report based on credentials](/applications/reference/upload-credentials) |

## Code Defender API

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

### Incidents API

| URL          | HTTP verb | Description                                                |
| :----------- | :-------- | :--------------------------------------------------------- |
| `/incidents` | `GET`     | [Get all incidents](/applications/reference/get-incidents) |

### Scripts API

| URL        | HTTP verb | Description                                                    |
| :--------- | :-------- | :------------------------------------------------------------- |
| `/scripts` | `GET`     | [Get all allowed scripts](/applications/reference/get-scripts) |

### Allow lists API

| URL            | HTTP verb | Description                                                        |
| :------------- | :-------- | :----------------------------------------------------------------- |
| `/allow-lists` | `GET`     | [Get all allowed actions](/applications/reference/get-allow-lists) |

### Deny lists API

| URL           | HTTP verb | Description                                                       |
| :------------ | :-------- | :---------------------------------------------------------------- |
| `/deny-lists` | `GET`     | [Get all blocked actions](/applications/reference/get-deny-lists) |

### Cookie report API

| URL              | HTTP verb | Description                                                      |
| :--------------- | :-------- | :--------------------------------------------------------------- |
| `/cookie-report` | `GET`     | [Get all cookie data](/applications/reference/get-cookie-report) |

### Account settings API

| URL                 | HTTP verb | Description                                                          |
| :------------------ | :-------- | :------------------------------------------------------------------- |
| `/account-settings` | `GET`     | [Get account settings](/applications/reference/get-account-settings) |

## PCI DSS API

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

### Inventory API

| URL                          | HTTP verb | Description                                                                          |
| :--------------------------- | :-------- | :----------------------------------------------------------------------------------- |
| `/inventory/scripts`         | `GET`     | [Get script inventory](/applications/reference/get-script-inventory)                 |
| `/non-pci/inventory/scripts` | `GET`     | [Get non-PCI script inventory](/applications/reference/get-non-pci-script-inventory) |
| `/inventory/headers`         | `GET`     | [Get header inventory](/applications/reference/get-header-inventory)                 |

> **Note**
>
> The non-PCI script inventory endpoint uses base domain `https://api-gw.perimeterx.com/v1`, not `https://api-gw.perimeterx.com/v1/pci`.

### Status API

| URL               | HTTP verb | Description                                                              |
| :---------------- | :-------- | :----------------------------------------------------------------------- |
| `/status/scripts` | `PUT`     | [Update a script's status](/applications/reference/update-script-status) |
| `/status/headers` | `PUT`     | [Update a header's status](/applications/reference/update-header-status) |

### Audits API

| URL               | HTTP verb | Description                                                    |
| :---------------- | :-------- | :------------------------------------------------------------- |
| `/audits/scripts` | `GET`     | [Get script audits](/applications/reference/get-script-audits) |
| `/audits/headers` | `GET`     | [Get header audits](/applications/reference/get-header-audits) |