PlexTrac

https://docs.plextrac.com/plextrac-documentation
Admin
PlexTrac is a cybersecurity platform that centralizes workflow management across the entire security...
Tokens:53,504
Snippets:813
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Query Documentation API

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/webhooks/verifying-sender-requests.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters.

```http
GET https://docs.plextrac.com/plextrac-documentation/api-documentation/webhooks/verifying-sender-requests.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with Agent

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/object-structures/asset-object.md

Perform an HTTP GET request to query documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter to guide the AI towards a broader objective.

```http
GET https://docs.plextrac.com/plextrac-documentation/api-documentation/object-structures/asset-object.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/dashboard.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for your specific question and the optional 'goal' parameter to guide the AI's response towards a broader objective. This is useful for retrieving information not explicitly present on the current page or for seeking clarification.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/dashboard.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/reports/findings/csv-findings-templates/using-report-findings-csv-template.md

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter to tailor the answer.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/reports/findings/csv-findings-templates/using-report-findings-csv-template.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/clients.md

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter to tailor the answer to a broader objective.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/clients.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/clients/using-short-codes-from-the-client-level-in-plextrac.md

Use this endpoint to dynamically query the documentation. Include an `ask` parameter for your specific question and an optional `goal` parameter to guide the response towards your broader objective.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/clients/using-short-codes-from-the-client-level-in-plextrac.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/analytics/trends-and-slas.md

Perform an HTTP GET request to query the documentation. Use the `ask` parameter for your specific question and the optional `goal` parameter to define your end objective.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/analytics/trends-and-slas.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/schedule/managing-engagements.md

Perform an HTTP GET request to the current page URL with the `ask` query parameter for specific questions and an optional `goal` parameter for broader objectives. Use this when information is not explicitly present or requires clarification.

```HTTP
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/schedule/managing-engagements.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/analytics/track-findings.md

Perform an HTTP GET request to query the documentation. Use the `ask` parameter for your question and optionally the `goal` parameter for broader context. The response includes a direct answer and relevant sources.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/analytics/track-findings.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/analytics.md

Perform an HTTP GET request to query the documentation. Use the `ask` parameter for your specific question and the optional `goal` parameter to tailor the answer to a broader objective. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/analytics.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/reports/export-report.md

Use this GET request to ask questions about the documentation when the answer is not explicitly present on the current page. The `ask` parameter is mandatory for specifying the question, and the `goal` parameter is optional for providing broader context.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/reports/export-report.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/clients/manage-client-users.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for a specific question and the optional 'goal' parameter to define the broader objective.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/clients/manage-client-users.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/object-structures.md

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for your question and optionally the 'goal' parameter to specify your end objective. This is useful for retrieving information not explicitly present on the current page or for clarification.

```http
GET https://docs.plextrac.com/plextrac-documentation/api-documentation/object-structures.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/reports/findings.md

Perform an HTTP GET request to the current page URL with the `ask` query parameter for a specific question and the optional `goal` query parameter for a broader objective. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/reports/findings.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with Ask and Goal Parameters

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/content-library/narrativesdb/creating-a-repository.md

Use this HTTP GET request to query the documentation dynamically. The 'ask' parameter is for your specific question, and the optional 'goal' parameter helps tailor the answer to your broader objective.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/content-library/narrativesdb/creating-a-repository.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/priorities/managing-priorities.md

Perform an HTTP GET request to query documentation. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to tailor the answer to a broader objective. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/priorities/managing-priorities.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Agent

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/assessments/take-assessment.md

Perform an HTTP GET request to query the documentation agent. Use the `ask` parameter for specific questions and the optional `goal` parameter to guide the agent's response towards a broader objective. This is useful when information is not explicitly present or requires clarification.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/assessments/take-assessment.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Port Data Formatting Examples

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/clients/adding-assets-to-a-client.md

Examples of valid data values for the ports field. Each port can have up to eight values, separated by a slash.

```text
80///////
80/open//////
80/open/tcp/////
80/closed/tcp/auth////
80/open/tcp/auth/ssh///
80/open/tcp/auth/ssh/test 6//
80/open/tcp/auth/ssh/test 6/Apache http 2.2.3 (CentOS)/
```

--------------------------------

### Get Available Webhook Events

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/webhooks.md

Send a GET request to this endpoint to retrieve a list of all available events that can be subscribed to via webhooks.

```text
{{toplevel_domain}}/api/internal/webhookevents
```

--------------------------------

### Deprecation of limit=99999 on Get Findings by Report

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/api-change-policy/api-change-log.md

Support for the `limit=99999` parameter on the Get Findings by Report endpoint is being deprecated and will be removed to address performance and stability issues.

```APIDOC
## POST /api/v2/clients/{clientId}/reports/{reportId}/findings

### Description
Retrieves a list of findings for a given report. Support for `limit=99999` is deprecated and will be removed. Users should adopt a paginated approach.

### Method
POST

### Endpoint
`/api/v2/clients/{clientId}/reports/{reportId}/findings`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - The ID of the client.
- **reportId** (string) - Required - The ID of the report.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of findings to return. Supported values are 1, 10, 50, 100. The value 99999 is deprecated and will be removed.

#### Request Body
- **requestBody** (object) - Optional - Request body for filtering or additional parameters.
```

--------------------------------

### Get Finding API Functionality Update

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/api-change-policy/api-change-log.md

The Get Finding endpoint has been updated to return a more concise data set, enhancing performance and security by excluding third-level relational data.

```APIDOC
## GET /api/v1/client/{{clientId}}/report/{{reportId}}/flaw/{{findingId}}

### Description
Retrieves finding information about the specified finding and its directly related affected assets. This update modifies the returned data to exclude third-level relational data for performance and security improvements.

### Method
GET

### Endpoint
`/api/v1/client/{{clientId}}/report/{{reportId}}/flaw/{{findingId}}`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - The ID of the client.
- **reportId** (string) - Required - The ID of the report.
- **findingId** (string) - Required - The ID of the finding.

### Response
#### Success Response (200)
- **finding** (object) - Information about the finding.
- **affectedAssets** (array) - A list of directly affected assets for the finding.
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/priorities/creating-a-priority.md

Use this endpoint to ask questions about the documentation. The `ask` parameter is mandatory for specifying your question, while `goal` is optional for providing broader context.

```http
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/priorities/creating-a-priority.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with Ask and Goal Parameters

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/webhooks/webhook-payload-structure.md

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.

```HTTP
GET https://docs.plextrac.com/plextrac-documentation/api-documentation/webhooks/webhook-payload-structure.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with Ask Parameter

Source: https://docs.plextrac.com/plextrac-documentation/product-documentation/schedule.md

To get additional information not directly on a page, perform an HTTP GET request with the 'ask' query parameter and an optional 'goal' parameter. 'ask' is for the immediate question, and 'goal' describes the broader objective.

```HTTP
GET https://docs.plextrac.com/plextrac-documentation/product-documentation/schedule.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/api-change-policy.md

Perform an HTTP GET request to query documentation dynamically. Include the 'ask' parameter for your question and optionally the 'goal' parameter for broader context.

```http
GET https://docs.plextrac.com/plextrac-documentation/api-documentation/api-change-policy.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Retrieving Webhooks

Source: https://docs.plextrac.com/plextrac-documentation/api-documentation/webhooks.md

Get a list of all configured webhooks.

```APIDOC
## GET /api/internal/webhooks

### Description
Retrieves a list of existing webhooks.

### Method
GET

### Endpoint
/api/internal/webhooks?page[size]=25&page[current]=1

### Parameters
#### Query Parameters
- **page[size]** (integer) - Optional - The number of webhooks to return per page. Defaults to 25.
- **page[current]** (integer) - Optional - The current page number. Defaults to 1.
```
Tokens:
Raw