Test Run
A Test Run is triggered for a specific target, each test run contains a set of probes used to check for specific vulnerabilities. These probes are pre-configured through the platform's UI.
Workspace Id.
Request payload to trigger the execution of a Test Run.
Name of the Test Run.
falseThe ids of the Probes that will be used in a Test Run.
falseThe id of the Target for which the Test Run will be triggered.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
POST /api/workspaces/{workspaceId}/test-run/trigger HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Content-Type: application/*+json
Accept: */*
Content-Length: 107
{
"name": "SplXAI Test Run",
"notifyWhenFinished": false,
"probeIds": [
1,
2,
3
],
"runAiAnalysis": false,
"targetId": 1
}{
"testRunId": 1
}Immediately cancel Test Run execution.
Test Run id.
Workspace Id.
OK
No content
Bad Request
Unauthorized
Forbidden
Internal Server Error
POST /api/workspaces/{workspaceId}/test-run/{testRunId}/cancel HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
No content
Get Test Run execution status.
Test Run id.
Workspace Id.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/workspaces/{workspaceId}/test-run/{id}/status HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"executionDate": "2025-09-12T13:04:27.806Z",
"probeRuns": [
{
"errorCount": 1,
"failedCount": 1,
"passedCount": 1,
"probeId": 1,
"probeName": "text",
"probeRunId": 1,
"status": "text",
"totalCount": 1
}
],
"status": "text",
"testRunId": 1
}Generate a PDF report for completed Test Run, which includes target details and a summary of the passed and failed test cases for each probe.
Test Run id.
Workspace Id.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/workspaces/{workspaceId}/test-run/{id}/report HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
binaryLast updated