Target

Create a Target for a specific Workspace

post

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.

Authorizations

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

Body

Request payload to create a new Target.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

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

{
  "connection": {
    "config": {
      "apiKey": "api_key",
      "apiVersion": null,
      "deploymentName": "gpt-4o-deployment",
      "extraLlmParams": null,
      "systemPrompt": null,
      "url": "https://your-azure-openai-endpoint.openai.azure.com/"
    },
    "type": "AZURE_OPENAI"
  },
  "settings": {
    "concurrentRequests": true,
    "description": "This is an example target for demonstration purposes.",
    "environment": "PROD",
    "language": "en",
    "name": "Example Target",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "This is a predefined response."
      }
    ],
    "ragFileId": "8f149328-2c3f-4280-b367-c163043e1acd",
    "ragFileNumberOfFacts": 5,
    "rateLimit": 100,
    "supportedModes": [
      "text",
      "video"
    ],
    "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."
    },
    "targetPresetId": "c2ece0db-dd88-493a-9ac3-56ebc25996e2"
  }
}

{
  "connection": {
    "config": null,
    "type": "text"
  },
  "id": 1,
  "scanId": 1,
  "settings": {
    "concurrentRequests": true,
    "description": "text",
    "environment": "text",
    "language": "text",
    "name": "text",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "text"
      }
    ],
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "ragFileNumberOfFacts": 1,
    "rateLimit": 1,
    "supportedModes": [
      "text"
    ],
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Update a Target for a specific Workspace

patch

This endpoint allows you to update an existing Target within a specified Workspace. The request body should contain the updated details for the Target.

Authorizations

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Body

Request payload to update an existing Target.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

patch

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

{
  "connection": {
    "config": {
      "apiKey": "api_key",
      "apiVersion": null,
      "deploymentName": "gpt-4o-deployment",
      "extraLlmParams": null,
      "systemPrompt": null,
      "url": "https://your-azure-openai-endpoint.openai.azure.com/"
    },
    "type": "AZURE_OPENAI"
  },
  "settings": {
    "concurrentRequests": true,
    "description": "This is an example target for demonstration purposes.",
    "environment": "PROD",
    "language": "en",
    "name": "Example Target",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "This is a predefined response."
      }
    ],
    "ragFileId": "7c7f3a66-f370-4398-b02a-5740b4d71636",
    "ragFileNumberOfFacts": 5,
    "rateLimit": 100,
    "supportedModes": [
      "text",
      "video"
    ],
    "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."
    },
    "targetPresetId": "aaf143cb-36aa-4491-a9ef-a8eac89f7405"
  }
}

{
  "connection": {
    "config": null,
    "type": "text"
  },
  "id": 1,
  "scanId": 1,
  "settings": {
    "concurrentRequests": true,
    "description": "text",
    "environment": "text",
    "language": "text",
    "name": "text",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "text"
      }
    ],
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "ragFileNumberOfFacts": 1,
    "rateLimit": 1,
    "supportedModes": [
      "text"
    ],
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Retrieve a Target for a specific Workspace

get

This endpoint allows you to retrieve details of a specific Target within a specified Workspace.

Authorizations

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

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

{
  "connection": {
    "config": null,
    "type": "text"
  },
  "id": 1,
  "scanId": 1,
  "settings": {
    "concurrentRequests": true,
    "description": "text",
    "environment": "text",
    "language": "text",
    "name": "text",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "text"
      }
    ],
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "ragFileNumberOfFacts": 1,
    "rateLimit": 1,
    "supportedModes": [
      "text"
    ],
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Delete Target from Workspace.

delete

Delete Target from the Workspace.

Authorizations

Path parameters

targetIdinteger · int32Required

Target Id.

workspaceIdinteger · int32Required

Workspace Id.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

delete

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

{
  "connection": {
    "config": null,
    "type": "text"
  },
  "id": 1,
  "scanId": 1,
  "settings": {
    "concurrentRequests": true,
    "description": "text",
    "environment": "text",
    "language": "text",
    "name": "text",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "text"
      }
    ],
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "ragFileNumberOfFacts": 1,
    "rateLimit": 1,
    "supportedModes": [
      "text"
    ],
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Target overview PDF report

get

Generate a PDF report of target overview, which includes target details and a summary of the passed and failed test cases for each latest probe run execution.

Authorizations

Path parameters

idinteger · int32Required

Target Id.

workspaceIdinteger · int32Required

Workspace Id.

Responses

200

Responsestring · binary

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

GET /api/workspaces/{workspaceId}/target/{id}/report HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

binary

Get Target types.

get

Retrieves a list of available Target Types (e.g. Private With RAG), including metadata and associated probe settings.

Authorizations

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

GET /api/target/types HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "details": [
      {
        "isRecommended": true,
        "probeId": 1,
        "weight": "LOW"
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text"
  }
]

Retrieve overall scores and category breakdown for a Target

get

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.

Authorizations

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

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

{
  "latestExecutionDate": "2025-08-31T21:20:18.785Z",
  "overallScore": 1,
  "scores": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "simulatedAttacks": 1,
  "successfulAttacks": 1
}

Retrieve test runs for a Target

get

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.

Authorizations

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

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

[
  {
    "errorCount": 1,
    "executionDate": "2025-08-31T21:20:18.785Z",
    "failedCount": 1,
    "id": 1,
    "name": "text",
    "passedCount": 1,
    "probes": [
      "text"
    ],
    "progress": 1,
    "startedBy": "text",
    "status": "text",
    "totalCount": 1
  }
]

PreviousProbe Run NextProbe Settings

Last updated 10 days ago