Target

Create a Target for a specific Workspace

post
/api/v2/workspaces/{workspaceId}/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.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

Body

Request payload to create a new Target.

Responses
chevron-right
200

OK

application/json
post
/api/v2/workspaces/{workspaceId}/target

Update a Target for a specific Workspace

patch
/api/v2/workspaces/{workspaceId}/target/{targetId}

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
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Body

Request payload to update an existing Target.

Responses
chevron-right
200

OK

application/json
patch
/api/v2/workspaces/{workspaceId}/target/{targetId}

Retrieve a Target for a specific Workspace

get
/api/v2/workspaces/{workspaceId}/target/{targetId}

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

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses
chevron-right
200

OK

application/json
get
/api/v2/workspaces/{workspaceId}/target/{targetId}

Delete Target from Workspace.

delete
/api/workspaces/{workspaceId}/target/{targetId}

Delete Target from the Workspace.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
targetIdinteger · int32Required

Target Id.

workspaceIdinteger · int32Required

Workspace Id.

Responses
chevron-right
200

OK

application/json
delete
/api/workspaces/{workspaceId}/target/{targetId}

Target overview PDF report

get
/api/workspaces/{workspaceId}/target/{id}/report

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
X-Api-KeystringRequired

API Key for authentication

Path parameters
idinteger · int32Required

Target Id.

workspaceIdinteger · int32Required

Workspace Id.

Responses
chevron-right
200

OK

Responsestring · binary
get
/api/workspaces/{workspaceId}/target/{id}/report

Get Target types.

get
/api/target/types

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

Authorizations
X-Api-KeystringRequired

API Key for authentication

Responses
chevron-right
200

OK

application/json
get
/api/target/types

Retrieve overall scores and category breakdown for a Target

get
/api/workspaces/{workspaceId}/target/{targetId}/scores

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
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses
chevron-right
200

OK

application/json
get
/api/workspaces/{workspaceId}/target/{targetId}/scores

Retrieve test runs for a Target

get
/api/workspaces/{workspaceId}/target/{targetId}/test-runs

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
X-Api-KeystringRequired

API Key for authentication

Path parameters
workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses
chevron-right
200

OK

application/json
get
/api/workspaces/{workspaceId}/target/{targetId}/test-runs

Last updated

Was this helpful?