Test Run | SplxAI Docs

SplxAI Sign up for free

Get Test Run Status

get

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

Authorizations

Path parameters

idinteger · int32required

Test Run id.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

500

{
  "testRunId": 1,
  "executionDate": "2025-03-26T17:16:01.618Z",
  "status": "text",
  "probeRuns": []
}

Test Run Execution PDF eport

get

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

Authorizations

Path parameters

idinteger · int32required

Test Run id.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

401

403

500

application/pdf

application/json

Binary PDF data

Cancel Test Run

get

Cancel ongoing Test Run execution.

Authorizations

Path parameters

testRunIdinteger · int32required

Test Run id.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

500

No body

Trigger Test Run

post

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

Authorizations

Body

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

cURL

JavaScript

Python

HTTP

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

{
  "testRunId": 1
}