Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-reference/credits/get-credit-balance.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Get credit balance"
openapi: "GET /credits"
description: "Read the organization's pentest credit balance."
description: "Get the pentest credits available to your organization, with totals purchased, used, refunded and granted, and whether the organization is unlimited."

Check warning on line 4 in api-reference/credits/get-credit-balance.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/credits/get-credit-balance.mdx#L4

Did you really mean 'pentest'?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Consolidate the duplicated API introductions

Mintlify renders description under the page title, so this new subtitle is followed immediately by line 7 restating the same credits, totals, and unlimited-status facts. Several other modified endpoint pages introduce the same description/body duplication, making readers consume each summary twice and leaving two copies that can drift apart. Consolidate each description and opening-paragraph pair while retaining the expanded metadata. .agents/skills/writing-docs/SKILL.mdL26-L30

Useful? React with 👍 / 👎.

---

Returns the pentest credits available to the organization, with totals purchased, used, refunded and granted. `is_unlimited` is true for organizations without a credit limit.

Check warning on line 7 in api-reference/credits/get-credit-balance.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/credits/get-credit-balance.mdx#L7

Did you really mean 'pentest'?

<Info>**Scope required**: `read`</Info>
2 changes: 1 addition & 1 deletion api-reference/findings/count-findings.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Count findings"
openapi: "GET /findings/counts"
description: "Count findings by severity, state and repository."
description: "Count findings with the same filters as List findings, without fetching every page. Returns the total plus counts by severity, state and repository."
---

Counts findings using the same filters as [List findings](/api-reference/findings/list-findings), without requiring you to fetch every page. The response includes the total and counts by severity, state and repository. Severity and state counts include zero values. Repositories appear in order of finding count, highest first.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/pentests/discard-pentest.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Discard pentest draft"

Check warning on line 2 in api-reference/pentests/discard-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/discard-pentest.mdx#L2

Did you really mean 'pentest'?
openapi: "DELETE /pentests/{id}"
description: "Delete a pentest that hasn't started."
description: "Delete a draft pentest that hasn't started, along with its saved login details. Use Stop scan instead to end a pentest that is already running."

Check warning on line 4 in api-reference/pentests/discard-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/discard-pentest.mdx#L4

Did you really mean 'pentest'?
---

Deletes a draft pentest and its saved login details. To end a pentest that has already started, use [Stop scan](/api-reference/scans/stop-scan).

Check warning on line 7 in api-reference/pentests/discard-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/discard-pentest.mdx#L7

Did you really mean 'pentest'?

<Info>**Scope required**: `write`. **Role**: member or above.</Info>
2 changes: 1 addition & 1 deletion api-reference/pentests/estimate-pentest.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Estimate pentest"

Check warning on line 2 in api-reference/pentests/estimate-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/estimate-pentest.mdx#L2

Did you really mean 'pentest'?
openapi: "POST /pentests/{id}/estimate"
description: "Price a draft pentest before starting it."
description: "Start a cost estimation for a draft pentest and get its cost_estimation_id, then poll Get cost estimation for the credit total to confirm at start."

Check warning on line 4 in api-reference/pentests/estimate-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/estimate-pentest.mdx#L4

Did you really mean 'pentest'?

Check warning on line 4 in api-reference/pentests/estimate-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/estimate-pentest.mdx#L4

Did you really mean 'cost_estimation_id'?
---

Starts a cost estimation for the draft and returns its `cost_estimation_id`. Poll [Get cost estimation](/api-reference/cost-estimations/get-cost-estimation) until its `status` is `completed` or `partial`.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/pentests/start-pentest.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: "Start pentest"

Check warning on line 2 in api-reference/pentests/start-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/start-pentest.mdx#L2

Did you really mean 'pentest'?
openapi: "POST /pentests/{id}/start"
description: "Start an estimated pentest and spend the confirmed credits."
description: "Start a draft pentest with a completed estimate. Confirm the expected credits, pass login checks for each target, and Hacktron deducts the credits."

Check warning on line 4 in api-reference/pentests/start-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/start-pentest.mdx#L4

Did you really mean 'Hacktron'?
---

Starts a draft pentest that has a completed estimate. Credits are deducted when it starts.

Check warning on line 7 in api-reference/pentests/start-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/start-pentest.mdx#L7

Did you really mean 'pentest'?

<Info>**Scope required**: `write`. **Role**: organization admin.</Info>

- Set `expected_credits` to the estimate's `total_credits`, plus `triage_fee_credits` if triage is required or you set `triage_enabled`. If the current cost differs from this total, the endpoint returns `409` without spending credits. If the organization has insufficient credits, it returns `402`.
- Every login target needs a login check that passed within the last hour. See [Check pentest logins](/api-reference/pentests/check-pentest-logins).

After it starts, follow the pentest with [Get scan status](/api-reference/scans/get-scan-status) using the same `scan_id`, read its results with [List scan findings](/api-reference/scans/list-scan-findings), or stop it with [Stop scan](/api-reference/scans/stop-scan).

Check warning on line 14 in api-reference/pentests/start-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/start-pentest.mdx#L14

Did you really mean 'pentest'?
2 changes: 1 addition & 1 deletion api-reference/pentests/update-pentest.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Update pentest draft"

Check warning on line 2 in api-reference/pentests/update-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/update-pentest.mdx#L2

Did you really mean 'pentest'?
openapi: "PATCH /pentests/{id}"
description: "Change a pentest that hasn't started."
description: "Update a draft pentest before it starts. Replace repositories, login targets or target URLs, then run the estimate again before starting the pentest."

Check warning on line 4 in api-reference/pentests/update-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/update-pentest.mdx#L4

Did you really mean 'pentest'?
---

Updates a draft pentest. Fields in the request replace their saved values. Omitted fields keep their current values. You can't change a pentest after it starts.

Check warning on line 7 in api-reference/pentests/update-pentest.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/pentests/update-pentest.mdx#L7

Did you really mean 'pentest'?

<Info>**Scope required**: `write`. **Role**: member or above.</Info>

Expand Down
2 changes: 1 addition & 1 deletion api-reference/repos/get-pr-review-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Get PR review settings"
openapi: "GET /pr-review-settings"
description: "Read how PR reviews behave across your organization."
description: "Get your organization's PR review settings: whether reviews post comments, the severity that fails the PR check, and which pull requests are reviewed."
---

Returns the PR review settings configured for your organization under **Settings** in Hacktron:

Check warning on line 7 in api-reference/repos/get-pr-review-settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/repos/get-pr-review-settings.mdx#L7

Did you really mean 'Hacktron'?

- `scm_comments_enabled`: reviews post comments and finding details on pull and merge requests.
- `scm_system_comments_enabled`: reviews also post system comments, such as skipped reviews, usage limits and configuration warnings.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/repos/update-pr-review-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Update PR review settings"
openapi: "PATCH /pr-review-settings"
description: "Change how PR reviews behave across your organization."
description: "Update your organization's PR review settings. Only fields you send change, filters replace the saved list, and null clears a filter or fail_on_severity."

Check warning on line 4 in api-reference/repos/update-pr-review-settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/repos/update-pr-review-settings.mdx#L4

Did you really mean 'fail_on_severity'?
---

Updates your organization's PR review settings and returns the full settings object. Only fields in the request change. Send `null` to disable `fail_on_severity` or clear a filter.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/scans/stop-scan.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Stop scan"
openapi: "POST /scans/{id}/stop"
description: "Stop a running scan or pentest."
description: "Stop a running scan or pentest and get its status. Members can stop their own pentests and any PR scan, and organization admins can stop any scan."

Check warning on line 4 in api-reference/scans/stop-scan.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/scans/stop-scan.mdx#L4

Did you really mean 'pentest'?

Check warning on line 4 in api-reference/scans/stop-scan.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/scans/stop-scan.mdx#L4

Did you really mean 'pentests'?
---

Stops a running scan and returns its status. Members can stop their own pentests and any PR scan. Organization admins can stop any scan.

Check warning on line 7 in api-reference/scans/stop-scan.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

api-reference/scans/stop-scan.mdx#L7

Did you really mean 'pentests'?

<Info>**Scope required**: `write`. **Role**: member or above.</Info>
2 changes: 1 addition & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Changelog"
description: "New features, improvements, and fixes."
description: "New features, improvements, and fixes in Hacktron, including updates to Whitebox pentests, Code Review, billing, integrations, and the dashboard."

Check warning on line 3 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

changelog.mdx#L3

Did you really mean 'Hacktron'?

Check warning on line 3 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

changelog.mdx#L3

Did you really mean 'Whitebox'?

Check warning on line 3 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (hacktronai) - vale-spellcheck

changelog.mdx#L3

Did you really mean 'pentests'?
rss: true
---

Expand Down
Loading