API Reference

PreviousUser & Organization Settings NextProduct Updates

Last updated 4 days ago

Trigger Test Run for a specific Target

Test Run will be triggered for a specific Target with a specific Probe that were perviously configured.

POST/api/v2/test-run/trigger

Authorization

Body

targetId*integer (int32)

Target id for which Test Run will be triggered.

probeIds*nullable array of integer (int32)

Probe ids for which Test Run will be triggered.

name*string

Test Run name.

Response

Body

id*integer (int32)

Test Run id.

Request

const response = await fetch('/api/v2/test-run/trigger', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "targetId": 1,
      "probeIds": [
        1,
        2,
        3
      ],
      "name": "SplXAI Test Run"
    }),
});
const data = await response.json();

Response

{
  "id": 1
}

Cancel Test Run execution.

Test Run execution will be immediately cancelled.

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

Authorization

Path parameters

testRunId*integer (int32)

Test Run id.

Response

Request

const response = await fetch('/api/v2/test-run/{testRunId}/cancel', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "error": {
    "message": "text",
    "code": "text"
  }
}

Get Test Run status.

Get Test Run execution status.

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

Authorization

Path parameters

id*integer (int32)

Test Run id.

Response

Body

testRunId*integer (int32)

executionDate*nullable string (date-time)

status*nullable string

probeRuns*nullable array of object

Request

const response = await fetch('/api/v2/test-run/{id}/status', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "testRunId": 1,
  "executionDate": "2025-02-05T08:07:04.237Z",
  "status": "text",
  "probeRuns": [
    {
      "probeName": "text",
      "probeRunId": 1,
      "probeId": 1,
      "totalCount": 1,
      "errorCount": 1,
      "passedCount": 1,
      "status": "text",
      "failedCount": 1
    }
  ]
}

Generate Test Run execution PDF report.

Generate a PDF report for completed Test Run executions.

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

Authorization

Path parameters

id*integer (int32)

Test Run id.

Response

Body

string (binary)

Request

const response = await fetch('/api/v2/test-run/{id}/report', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

text