Probe Settings

Create Probe Settings for a Target.

post

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

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Body

application/*+jsonapplication/jsonapplication/json-patch+jsontext/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

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

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

{
  "config": {
    "inputs": {
      "attack_multiplier": 10,
      "conversation_depth": 5,
      "custom_adversarial": true,
      "custom_on_domain": true,
      "entriesCount": 2,
      "fileId": "4ad01246-954c-42dd-b3c5-11cd69a5350f",
      "fileName": "custom_dataset.csv",
      "intent": "Custom Dataset Intent",
      "languages": [
        "en",
        "hr"
      ],
      "probe_name": "Custom Dataset",
      "strategy_list": [
        "one_shot_w_retry",
        "multishot",
        "delayed_attack"
      ],
      "variation_list": [
        "leet",
        "multilanguage",
        "rag"
      ]
    },
    "probeId": null,
    "probeType": "CUSTOM_DATASET"
  },
  "isEnabled": true,
  "riskPriority": "CRITICAL"
}

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

Example of a Custom Dataset settingExample of a Custom Probe settingExample of a Predefined Probe setting

{
  "dateCreated": "2025-07-17T18:31:50.089Z",
  "enabled": true,
  "probeId": 1,
  "probeSettingsId": 1,
  "probeType": "text",
  "userInputConfig": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update Probe Settings for a Target.

patch

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

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

probeSettingsIdinteger · int32Required

Probe Settings Id.

Body

application/*+jsonapplication/jsonapplication/json-patch+jsontext/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

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "config": {
    "inputs": {
      "attack_multiplier": 12,
      "conversation_depth": 6,
      "custom_adversarial": false,
      "custom_on_domain": false,
      "entriesCount": 3,
      "fileId": "4ad01246-954c-42dd-b3c5-11cd69a5350f",
      "fileName": "updated_custom_dataset.csv",
      "intent": "Updated Custom Dataset Intent",
      "languages": [
        "en",
        "hr",
        "de"
      ],
      "probe_name": "Updated Custom Dataset",
      "strategy_list": [
        "one_shot_w_retry",
        "multishot"
      ],
      "variation_list": [
        "leet",
        "multilanguage",
        "rag",
        "binary_tree"
      ]
    }
  },
  "isEnabled": true,
  "riskPriority": "CRITICAL"
}

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

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

{
  "dateCreated": "2025-07-17T18:31:50.089Z",
  "enabled": true,
  "probeId": 1,
  "probeSettingsId": 1,
  "probeType": "text",
  "userInputConfig": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Probe Settings for a Target.

get

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

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

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

[
  {
    "dateCreated": "2025-07-17T18:31:50.089Z",
    "enabled": true,
    "probeId": 1,
    "probeSettingsId": 1,
    "probeType": "text",
    "userInputConfig": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]