Sign in
Security Penetration Tests

Create penetration test

Creates a new penetration test run and returns the run metadata.

post/v1/security-penetration-tests

Headers

X-Organization-Idstring

Organization ID (required for session auth, optional for API key auth)

Request body

targetUrlstring required

Target URL for the penetration test scan

repoUrlstring

Repository URL containing the target application code

githubTokenstring

GitHub token used for cloning private repositories

configYamlstring

Optional YAML configuration for the pentest run

pipelineTestingboolean

Whether to enable pipeline testing mode

workspacestring

Workspace identifier used by the pentest engine

webhookUrlstring

Optional webhook URL to notify when report generation completes

testModeboolean

Whether to run the pentest in simulation mode

Example request

{
  "targetUrl": "https://app.example.com",
  "repoUrl": "https://github.com/org/repo"
}

Response

Penetration test created

Changes