MImindfort
Assessments

Trigger Assessment

Requests a new security assessment against the specified target. Accepted assessments run asynchronously; review their status and available results in the MindFort dashboard.

post/v1/assessments/run

Request

  • Base URL
    https://api.mindfort.app
  • URL
    https://api.mindfort.app/v1/assessments/run
  • Auth
    HTTP bearer

Request body

target_idstring uuid required

UUID of the target to assess

assessment_type'black-box' | 'white-box'

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

assessment_method'balanced' | 'deep' | 'ultra'

Assessment method. Balanced is the default; Deep and Ultra allow more time for investigation. Coverage depends on the target's scope, available access, and scenarios investigated.

target_credential_idstring uuid

UUID of the primary stored credential to use for authenticated testing

secondary_target_credential_idstring uuid

UUID of a different secondary stored credential for cross-account authorization testing; requires target_credential_id

Response

Assessment triggered successfully

messagestring required
assessment_idstring uuid nullable
target_idstring uuid required
assessment_type'black-box' | 'white-box' required
assessment_method'balanced' | 'deep' | 'ultra' required
assessment_startedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.