Ctrlk
Zscaler (SPLX)
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Probe Run

Retrieve detailed probe run execution data and analysis results

get
/api/workspaces/{workspaceId}/probe-run/{probeRunId}

Returns comprehensive execution details for a specific probe run, including test case results, AI-powered vulnerability analysis, remediation strategies, and execution metrics. This endpoint provides deep insights into security probe performance and discovered vulnerabilities.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

probeRunIdinteger · int32Required

Probe Run Id.

Responses
200

OK

application/json

Detailed execution data and analysis results for a specific probe run.

probeRunIdinteger · int32Optional

Unique identifier for probe run execution.

scanRunIdinteger · int32 · nullableOptional

Scan run identifier that initiated this probe.

probeIdinteger · int32 · nullableOptional

Identifier of the Probe.

executionStartstring · date-time · nullableOptional

Timestamp when the probe execution started.

executionEndstring · date-time · nullableOptional

Timestamp when the probe execution completed. Null if still running.

probeNamestring · nullableRequired

Name of the executed probe.

statusstring · nullableRequired

Current execution status of the probe run.

totalCountinteger · int32 · nullableOptional

Total number of test cases planned for execution.

processedCountinteger · int32Optional

Number of test cases that have been processed.

errorCountinteger · int32Optional

Number of test cases that encountered execution errors.

passedCountinteger · int32Optional

Number of test cases that passed (no risk found).

failedCountinteger · int32Optional

Number of test cases that failed (potential risk detected).

acceptedCountinteger · int32Optional

Number of failed test cases that have been reviewed and the risk has been accepted.

progressnumber · floatOptional

Execution progress.

isAiAnalysisFinishedbooleanOptional

Indicates whether AI analysis of the probe run results has been completed.

get/api/workspaces/{workspaceId}/probe-run/{probeRunId}
GET /api/workspaces/{workspaceId}/probe-run/{probeRunId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "probeRunId": 1,
  "scanRunId": 1,
  "probeId": 1,
  "executionStart": "2026-01-01T00:00:00.000Z",
  "executionEnd": "2026-01-01T00:00:00.000Z",
  "probeName": "text",
  "status": "text",
  "totalCount": 1,
  "processedCount": 1,
  "errorCount": 1,
  "passedCount": 1,
  "failedCount": 1,
  "acceptedCount": 1,
  "progress": 1,
  "isAiAnalysisFinished": true,
  "testCaseResults": [
    {
      "id": 1,
      "attackId": "text",
      "attempt": 1,
      "status": "text",
      "strategy": "text",
      "redTeamer": "text",
      "variation": "text",
      "detectionTime": "2026-01-01T00:00:00.000Z",
      "redTeamerLabels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "isRiskAccepted": true,
      "riskAcceptedBy": "text",
      "riskAcceptedDate": "2026-01-01T00:00:00.000Z",
      "editedStatusBy": "text",
      "editedStatusDate": "2026-01-01T00:00:00.000Z",
      "isIncludedInReport": true
    }
  ],
  "remediation": {
    "tasks": [
      {
        "id": 1,
        "name": "text",
        "details": "text",
        "completed": true,
        "type": "text",
        "appliedBy": "text",
        "appliedDate": "2026-01-01T00:00:00.000Z"
      }
    ],
    "dynamicTasks": [
      {
        "id": 1,
        "name": "text",
        "details": "text",
        "completed": true,
        "type": "text",
        "appliedBy": "text",
        "appliedDate": "2026-01-01T00:00:00.000Z"
      }
    ]
  },
  "aiAnalysis": {
    "id": 1,
    "overview": "text",
    "methods": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "data": {
          "failRate": 1,
          "criticalTestCaseIds": [
            1
          ],
          "failedTestCaseCount": 1,
          "totalTestCaseCount": 1
        }
      }
    ]
  }
}

Trigger AI Analysis for a Scan Probe Run

post
/api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis/trigger

This endpoint triggers the AI analysis process for a specific scan probe run execution.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

probeRunIdinteger · int32Required

Probe Run Id.

Responses
200

OK

No content
post/api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis/trigger
POST /api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis/trigger HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

No content

Get AI Analysis results for a Scan Probe Run

get
/api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis

This endpoint retrieves the AI analysis results for a specific scan probe run execution.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

probeRunIdinteger · int32Required

Probe Run Id.

Responses
200

OK

application/json

AI-powered analysis of scan probe run results, providing strategic insights and risk clustering.

idinteger · int64Required

Unique identifier for AI analysis instance.

overviewstring · nullableRequired

High-level AI-generated summary of the scan probe run results, key findings, and overall security assessment.

get/api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis
GET /api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "overview": "text",
  "attackClusters": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "data": {
        "failRate": 1,
        "criticalTestCaseIds": [
          1
        ],
        "failedTestCaseCount": 1,
        "totalTestCaseCount": 1
      }
    }
  ]
}
PreviousTest Run
NextFile

Last updated

Was this helpful?