Probe Settings

Create Probe Settings for a Target.

post

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/workspaces/{workspaceId}/target/{targetId}/probe-settings

This endpoint creates new probe settings for a specific target in a workspace. Probe settings define how probes are configured and used for testing vulnerabilities.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Body

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

Request payload to create new Probe Settings for a Target.

isEnabledbooleanRequired

Enables or disables the Probe.

riskPrioritystring · nullableRequired

The risk priority of the Probe, e.g., 'LOW', 'MEDIUM', 'HIGH' or 'CRITICAL'.

Responses

200

OK

application/json

probeSettingsIdinteger · int32Optional

probeIdinteger · int32Optional

probeNamestring · nullableRequired

probeCategoryNamestring · nullableRequired

probeTypestring · nullableRequired

enabledbooleanOptional

dateCreatedstring · date-time · nullableOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post/api/workspaces/{workspaceId}/target/{targetId}/probe-settings

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/target/{targetId}/probe-settings HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 177

{
  "isEnabled": true,
  "riskPriority": "CRITICAL",
  "config": {
    "probeType": "PREDEFINED",
    "probeId": 51,
    "inputs": {
      "coverage": "BASIC",
      "additional_information": "Any Additional information"
    }
  }
}

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

Example of a Predefined Probe settingExample of a Custom Probe settingExample of a Custom Dataset settingExample of a Q&A Probe setting

{
  "probeSettingsId": 1,
  "probeId": 1,
  "probeName": "text",
  "probeCategoryName": "text",
  "probeType": "text",
  "userInputConfig": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "dateCreated": "2026-07-10T15:52:10.397Z",
  "files": [
    {
      "fileName": "text",
      "fileId": "text",
      "link": "text",
      "token": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "color": "text"
    }
  ],
  "riskPriority": {
    "weight": "text",
    "defaultWeight": "text",
    "isRecommended": true
  }
}

Update Probe Settings for a Target.

patch

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/workspaces/{workspaceId}/target/{targetId}/probe-settings/{probeSettingsId}

This endpoint updates existing probe settings for a specific target in a workspace. Probe settings define how probes are configured and used for testing vulnerabilities.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

probeSettingsIdinteger · int32Required

Probe Settings Id.

Body

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

isEnabledboolean · nullableOptional

Enables or disables the Probe.

riskPrioritystring · nullableOptional

The risk priority of the Probe, e.g., 'LOW', 'MEDIUM', 'HIGH' or 'CRITICAL'.

Responses

200

OK

application/json

probeSettingsIdinteger · int32Optional

probeIdinteger · int32Optional

probeNamestring · nullableRequired

probeCategoryNamestring · nullableRequired

probeTypestring · nullableRequired

enabledbooleanOptional

dateCreatedstring · date-time · nullableOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

patch/api/workspaces/{workspaceId}/target/{targetId}/probe-settings/{probeSettingsId}

HTTPcURLJavaScriptPython

PATCH /api/workspaces/{workspaceId}/target/{targetId}/probe-settings/{probeSettingsId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 53

{
  "isEnabled": false,
  "riskPriority": null,
  "config": null
}

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

Example of disabling a ProbeExample of changing Risk Priority of a ProbeExample of a Predefined Probe setting updateExample of a Custom Probe setting updateExample of a Custom Dataset setting updateExample of a Q&A Probe setting

{
  "probeSettingsId": 1,
  "probeId": 1,
  "probeName": "text",
  "probeCategoryName": "text",
  "probeType": "text",
  "userInputConfig": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "dateCreated": "2026-07-10T15:52:10.397Z",
  "files": [
    {
      "fileName": "text",
      "fileId": "text",
      "link": "text",
      "token": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "color": "text"
    }
  ],
  "riskPriority": {
    "weight": "text",
    "defaultWeight": "text",
    "isRecommended": true
  }
}

Get Probe Settings for a Target.

get

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/workspaces/{workspaceId}/target/{targetId}/probe-settings

This endpoint retrieves the probe settings for a specific target in a workspace. Probe settings define how probes are configured and used for testing vulnerabilities.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

OK

application/json

probeSettingsIdinteger · int32Optional

probeIdinteger · int32Optional

probeNamestring · nullableRequired

probeCategoryNamestring · nullableRequired

probeTypestring · nullableRequired

enabledbooleanOptional

dateCreatedstring · date-time · nullableOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/workspaces/{workspaceId}/target/{targetId}/probe-settings

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/target/{targetId}/probe-settings HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "probeSettingsId": 1,
    "probeId": 1,
    "probeName": "text",
    "probeCategoryName": "text",
    "probeType": "text",
    "userInputConfig": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "enabled": true,
    "dateCreated": "2026-07-10T15:52:10.397Z",
    "files": [
      {
        "fileName": "text",
        "fileId": "text",
        "link": "text",
        "token": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "color": "text"
      }
    ],
    "riskPriority": {
      "weight": "text",
      "defaultWeight": "text",
      "isRecommended": true
    }
  }
]