Skip to main content
POST
Trigger Assessment

Authorizations

Authorization
string
header
required

API key generated from the MindFort dashboard. Pass as Authorization: Bearer <your-api-key>.

Body

application/json
target_id
string<uuid>
required

UUID of the target to assess

assessment_type
enum<string>
default:black-box

Assessment mode. White-box includes code context and requires an enabled associated repository plus a GitHub App installation that can access it.

Available options:
black-box,
white-box
assessment_method
enum<string>
default:balanced

Assessment thoroughness. Balanced is the default; Ultra is the most exhaustive.

Available options:
balanced,
deep,
ultra
target_credential_id
string<uuid>

UUID of stored credentials to use for authenticated testing

Response

Assessment triggered successfully

message
string
required
target_id
string<uuid>
required
assessment_type
enum<string>
required
Available options:
black-box,
white-box
assessment_method
enum<string>
required
Available options:
balanced,
deep,
ultra
assessment_started
boolean
required
assessment_id
string<uuid> | null