Target
This endpoint allows you to create a new Target within a specified Workspace. The request body should contain the necessary details for the new Target.
API Key for authentication
Workspace Id.
Request payload to create a new Target.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
POST /api/v2/workspaces/{workspaceId}/target HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 974
{
"connection": {
"type": "AZURE_OPENAI",
"config": {
"apiKey": "api_key",
"url": "https://your-azure-openai-endpoint.openai.azure.com/",
"systemPrompt": null,
"deploymentName": "gpt-4o-deployment",
"apiVersion": null,
"extraLlmParams": null
}
},
"settings": {
"name": "Example Target",
"environment": "PROD",
"description": "This is an example target for demonstration purposes.",
"language": "en",
"rateLimit": 100,
"supportedModes": [
"text",
"video"
],
"concurrentRequests": true,
"multiStepAttacks": true,
"systemPromptConfigurations": {
"systemPromptConfidential": "This is a confidential part of the system prompt.",
"systemPromptNotConfidential": "This is a non-confidential part of the system prompt.",
"systemPromptTools": "These are the tools available for the system prompt."
},
"ragFileId": "319b2ff1-614e-4e61-96fc-403c5d3e48c7",
"predefinedResponses": [
{
"type": "text",
"value": "This is a predefined response."
}
],
"ragFileNumberOfFacts": 5,
"targetPresetId": "0e731c86-a3c7-4850-af0e-5b9b9fc4defe",
"workerPoolId": null
}
}{
"id": 1,
"scanId": 1,
"connection": {
"type": "text",
"config": null
},
"settings": {
"name": "text",
"environment": "text",
"supportedModes": [
"text"
],
"description": "text",
"concurrentRequests": true,
"multiStepAttacks": true,
"language": "text",
"rateLimit": 1,
"targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
"systemPromptConfigurations": {
"systemPromptConfidential": "text",
"systemPromptNotConfidential": "text",
"systemPromptTools": "text"
},
"ragFile": {
"ragFileId": "123e4567-e89b-12d3-a456-426614174000",
"ragFileName": "text",
"ragFileUrl": "text"
},
"workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
"predefinedResponses": [
{
"value": "text",
"type": "text"
}
],
"ragFileNumberOfFacts": 1
}
}This endpoint allows you to update an existing Target within a specified Workspace. The request body should contain the updated details for the Target.
API Key for authentication
Workspace Id.
Target Id.
Request payload to update an existing Target.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
PATCH /api/v2/workspaces/{workspaceId}/target/{targetId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 974
{
"connection": {
"type": "AZURE_OPENAI",
"config": {
"apiKey": "api_key",
"url": "https://your-azure-openai-endpoint.openai.azure.com/",
"systemPrompt": null,
"deploymentName": "gpt-4o-deployment",
"apiVersion": null,
"extraLlmParams": null
}
},
"settings": {
"name": "Example Target",
"environment": "PROD",
"description": "This is an example target for demonstration purposes.",
"language": "en",
"rateLimit": 100,
"supportedModes": [
"text",
"video"
],
"concurrentRequests": true,
"multiStepAttacks": true,
"systemPromptConfigurations": {
"systemPromptConfidential": "This is a confidential part of the system prompt.",
"systemPromptNotConfidential": "This is a non-confidential part of the system prompt.",
"systemPromptTools": "These are the tools available for the system prompt."
},
"ragFileId": "c3ba6b13-fcf0-46ba-a89a-bbe6a5a5e37b",
"predefinedResponses": [
{
"type": "text",
"value": "This is a predefined response."
}
],
"ragFileNumberOfFacts": 5,
"targetPresetId": "a6ae93bc-7243-4c07-814f-d36b5799cfa3",
"workerPoolId": null
}
}{
"id": 1,
"scanId": 1,
"connection": {
"type": "text",
"config": null
},
"settings": {
"name": "text",
"environment": "text",
"supportedModes": [
"text"
],
"description": "text",
"concurrentRequests": true,
"multiStepAttacks": true,
"language": "text",
"rateLimit": 1,
"targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
"systemPromptConfigurations": {
"systemPromptConfidential": "text",
"systemPromptNotConfidential": "text",
"systemPromptTools": "text"
},
"ragFile": {
"ragFileId": "123e4567-e89b-12d3-a456-426614174000",
"ragFileName": "text",
"ragFileUrl": "text"
},
"workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
"predefinedResponses": [
{
"value": "text",
"type": "text"
}
],
"ragFileNumberOfFacts": 1
}
}This endpoint allows you to retrieve details of a specific Target within a specified Workspace.
API Key for authentication
Workspace Id.
Target Id.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/v2/workspaces/{workspaceId}/target/{targetId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"id": 1,
"scanId": 1,
"connection": {
"type": "text",
"config": null
},
"settings": {
"name": "text",
"environment": "text",
"supportedModes": [
"text"
],
"description": "text",
"concurrentRequests": true,
"multiStepAttacks": true,
"language": "text",
"rateLimit": 1,
"targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
"systemPromptConfigurations": {
"systemPromptConfidential": "text",
"systemPromptNotConfidential": "text",
"systemPromptTools": "text"
},
"ragFile": {
"ragFileId": "123e4567-e89b-12d3-a456-426614174000",
"ragFileName": "text",
"ragFileUrl": "text"
},
"workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
"predefinedResponses": [
{
"value": "text",
"type": "text"
}
],
"ragFileNumberOfFacts": 1
}
}Delete Target from the Workspace.
API Key for authentication
Target Id.
Workspace Id.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
DELETE /api/workspaces/{workspaceId}/target/{targetId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"id": 1,
"scanId": 1,
"connection": {
"type": "text",
"config": null
},
"settings": {
"name": "text",
"environment": "text",
"supportedModes": [
"text"
],
"description": "text",
"concurrentRequests": true,
"multiStepAttacks": true,
"language": "text",
"rateLimit": 1,
"targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
"systemPromptConfigurations": {
"systemPromptConfidential": "text",
"systemPromptNotConfidential": "text",
"systemPromptTools": "text"
},
"ragFile": {
"ragFileId": "123e4567-e89b-12d3-a456-426614174000",
"ragFileName": "text",
"ragFileUrl": "text"
},
"workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
"predefinedResponses": [
{
"value": "text",
"type": "text"
}
],
"ragFileNumberOfFacts": 1
}
}Retrieves a list of available Target Types (e.g. Private With RAG), including metadata and associated probe settings.
API Key for authentication
OK
Defines various target configurations and their key characteristics. It helps determine which Probes are most appropriate and what Risk Levels apply, ensuring accurate analysis based on the specific setup.
Target type Id.
Target type label/name.
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/target/types HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": "text",
"details": [
{
"probeId": 1,
"isRecommended": true,
"weight": "LOW"
}
]
}
]Retrieve overall scores and category breakdown for a Target
Returns the overall score and scores per category for a specific Target within a Workspace. Scores are calculated based on the latest probe run results and provide insights into security vulnerabilities, compliance issues, and other risk factors.
API Key for authentication
Workspace Id.
Target Id.
OK
Response payload containing overall score overview and detailed category breakdown from probe scan results.
Total number of simulated attacks executed during the probe runs.
Number of attacks that successfully exploited vulnerabilities or weaknesses.
Current overall score calculated from all probe results. Scale: 0-100 (0 = Critical Risk, 100 = Low Risk).
Timestamp of the most recent probe execution used in this overall score calculation.
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/workspaces/{workspaceId}/target/{targetId}/scores HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"simulatedAttacks": 1,
"successfulAttacks": 1,
"overallScore": 1,
"scores": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"latestExecutionDate": "2026-01-01T00:00:00.000Z"
}Returns a list of test runs for a specific Target within a Workspace. This includes all test runs with their execution status, progress, probes and result summaries.
API Key for authentication
Workspace Id.
Target Id.
OK
Response payload containing execution details and status information for a test run.
Unique identifier for the test run execution.
Name of the test run execution.
Timestamp when the test run was executed. Null if not yet executed.
Email of the user who initiated this test run.
Number of test cases that encountered execution errors.
Number of test cases that passed (no risk found).
Number of test cases that failed (potential risk detected).
Total number of test cases planned for execution.
Test run progress.
Current status of the test run (e.g., 'RUNNING', 'COMPLETED', 'FAILED' and 'CANCELLED').
List of probe names included in this test run.
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/workspaces/{workspaceId}/target/{targetId}/test-runs HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"name": "text",
"executionDate": "2026-01-01T00:00:00.000Z",
"startedBy": "text",
"errorCount": 1,
"passedCount": 1,
"failedCount": 1,
"totalCount": 1,
"progress": 1,
"status": "text",
"probes": [
"text"
]
}
]Last updated
Was this helpful?