SplxAISign up for free

Test Run

Trigger Test Run for a specific Target

post

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.

Authorizations
Path parameters
workspaceIdinteger · int32Required

Workspace Id.

Body

Request payload to trigger the execution of a Test Run.

namestringRequired

Name of the Test Run.

notifyWhenFinishedbooleanRequiredDefault: false
probeIdsinteger · int32[] | nullableRequired

The ids of the Probes that will be used in a Test Run.

runAiAnalysisbooleanRequiredDefault: false
targetIdinteger · int32Required

The id of the Target for which the Test Run will be triggered.

Responses
200
OK
application/json
post
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
}

Cancel Test Run execution

post

Immediately cancel Test Run execution.

Authorizations
Path parameters
testRunIdinteger · int32Required

Test Run id.

workspaceIdinteger · int32Required

Workspace Id.

Responses
200
OK
post
POST /api/workspaces/{workspaceId}/test-run/{testRunId}/cancel HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

No content

Get Test Run status

get

Get Test Run execution status.

Authorizations
Path parameters
idinteger · int32Required

Test Run id.

workspaceIdinteger · int32Required

Workspace Id.

Responses
200
OK
application/json
get
GET /api/workspaces/{workspaceId}/test-run/{id}/status HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "executionDate": "2025-07-28T12:27:58.061Z",
  "probeRuns": [
    {
      "errorCount": 1,
      "failedCount": 1,
      "passedCount": 1,
      "probeId": 1,
      "probeName": "text",
      "probeRunId": 1,
      "status": "text",
      "totalCount": 1
    }
  ],
  "status": "text",
  "testRunId": 1
}

Test Run execution PDF report

get

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.

Authorizations
Path parameters
idinteger · int32Required

Test Run id.

workspaceIdinteger · int32Required

Workspace Id.

Responses
200
OK
Responsestring · binary
get
GET /api/workspaces/{workspaceId}/test-run/{id}/report HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

binary
PreviousAPI ReferenceNextProbe Run

Last updated