> For the complete documentation index, see [llms.txt](https://docs.nullify.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nullify.ai/configuration/configuration-api.md).

# API Configuration

## Overview

Dynamic Application Security Testing (DAST) produces API findings by testing your running applications. Manage applications, targets, and credentials from the Nullify dashboard or through the API.

Use the [dashboard engagement workflow](https://docs.nullify.ai/capabilities/pentests/engagement-workflow.md#dashboard) to request a pentest and review its results. Store application settings and test credentials in the dashboard.

When you request a pentest with the [CLI](https://docs.nullify.ai/capabilities/pentests/engagement-workflow.md#cli), from CLI version 0.29.0 the assessment uses the credentials stored on the application; the CLI no longer takes an `--auth-config` file. The dashboard is the source of truth for applications and credentials.

## Service account tokens

CLI and API access outside a browser session uses a service-account token. Manage service accounts through the admin API — `GET`, `POST`, and `DELETE` on `/admin/service_accounts` — which requires the **Admin** role. Creation accepts one built-in role: `builtin:viewer`, `builtin:editor`, or `builtin:admin`. It does not accept individual permission grants; omitting `role` defaults to `builtin:admin`.

Choose the least-privileged built-in role that covers the task:

| Task                                                                      | Minimum role     |
| ------------------------------------------------------------------------- | ---------------- |
| Request or stop a pentest, allowlist a finding, create or remove a ticket | `builtin:editor` |
| Read scans, findings, and reports                                         | `builtin:viewer` |
| Create or update applications and credentials                             | `builtin:admin`  |
| Read stored credentials                                                   | `builtin:admin`  |

Pass the token as `NULLIFY_TOKEN` in the environment, or with `--nullify-token`.

## Credentials

Credentials are stored per tenant, encrypted at rest, and returned masked. Manage them with:

```
GET    /dast/credentials
POST   /dast/credentials
PUT    /dast/credentials/{credentialId}
DELETE /dast/credentials/{credentialId}
POST   /dast/credentials/{credentialId}/validate
```

Customer credential checks require an eligible workspace. See [Assessment API availability](https://docs.nullify.ai/api-reference/api-reference/pentester.md#availability). Review credential readiness with Nullify before the engagement.

## Source IP addresses

Ask your Nullify contact for the addresses to allowlist for the engagement.

## Ignore findings

Suppress an API finding by allowlisting it per-finding from the dashboard or via the API, e.g. for a pentest finding:

```
POST /dast/pentest/findings/{findingId}/allowlist
```

Request body:

```json
{
  "allowlistReason": "Endpoint is internal-only and not reachable in production",
  "allowlistType": "UserAssumeRisk"
}
```

`allowlistType` is one of `AI`, `UserFixed`, `UserAssumeRisk`, `UserFalsePositive`, or `UserOther`.

## Pull request gate and notifications

API findings are not part of the pull request **Nullify** check, so they do not fail CI. Alert delivery is managed centrally, including a separate new-API-findings event — see [Notifications](https://docs.nullify.ai/configuration/configuration-notifications.md).

## Access and execution limits

Nullify checks the required role permissions on customer requests. Deleting a service account revokes its token for authenticated tenant API requests. See [API Authentication](https://docs.nullify.ai/api-reference/api-reference/authentication.md#authorization-and-token-lifetime) for token lifetime and rotation.

Customer pentest requests enter manual review before a Nullify operator starts a run. See [Engagement Workflow](https://docs.nullify.ai/capabilities/pentests/engagement-workflow.md) for review and run statuses.
