Test Run

Trigger Test Run

Trigger a new test run for a specified target with a predefined set of probes configured via the SplxAI Platform UI.<br><br>To learn more about Test Runs and see a visual reference, visit the Test Run documentation page.

post

/api/v2/test-run/trigger

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

targetIdinteger · int32required

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

probeIdsinteger · int32[] | nullablerequired

The ids of the Probes that will be used in a test run.

namestringrequired

Name of the Test Run.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v2/test-run/trigger' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "targetId": 1,
    "probeIds": [
      1,
      2,
      3
    ],
    "name": "SplXAI Test Run"
  }'

200

400

401

403

500

200

{
  "testRunId": 1
}

OK

Cancel Test Run

Cancel ongoing Test Run execution.

get

/api/v2/test-run/{testRunId}/cancel

Authorizations

Path parameters

testRunIdinteger · int32required

Test Run id.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v2/test-run/{testRunId}/cancel' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

400

401

403

500

200

No body

OK

Get Test Run Status

Get Test Run execution status. <br><br>Learn more about Test Run statuses on the Test Run documentation page.

get

/api/v2/test-run/{id}/status

Authorizations

Path parameters

idinteger · int32required

Test Run id.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v2/test-run/{id}/status' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

400

401

403

500

200

{
  "testRunId": 1,
  "executionDate": "2025-03-13T17:49:29.449Z",
  "status": "text",
  "probeRuns": []
}

OK

Test Run Execution PDF eport

Generate a PDF report for a completed Test Run. <br><br> Visit the Test Run Report documentation page for more information about the report.

get

/api/v2/test-run/{id}/report

Authorizations

Path parameters

idinteger · int32required

Test Run id.

Responses

application/pdfapplication/json

application/pdfapplication/json

application/pdfapplication/json

application/pdfapplication/json

application/pdfapplication/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v2/test-run/{id}/report' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

400

401

403

500

200

application/pdf

application/json

application/pdf

Binary PDF data

OK