# Hacktron Docs

- [Welcome](https://docs.hacktron.ai/index.md): Hacktron is an AI-powered security code-review platform. Our AI agents review your repositories for exploitable vulnerabilities and surface them as pull-request comments and dashboard findings. It works in two modes: per-PR reviews that run on each pull or merge request, and whitebox scans (also cal…
- [Platform Overview](https://docs.hacktron.ai/platform/overview.md): Use the Hacktron Platform to manage integrations, code reviews, pentests, access, and billing across your organization.
- [Dashboard](https://docs.hacktron.ai/platform/dashboard.md): Track Code Review and Whitebox scan activity across your organization from the Hacktron dashboard.
- [On-premises deployment](https://docs.hacktron.ai/platform/on-premises.md): Set up the Hacktron Enterprise appliance, connect internal Git hosts, and collect support logs without internet access.
- [Integrations](https://docs.hacktron.ai/platform/integrations.md): Connect SCM, project management, and communication tools to the Hacktron Platform.
- [Overview](https://docs.hacktron.ai/platform/repositories.md): Choose which connected repositories Hacktron should review and configure how repository access is managed.
- [GitHub](https://docs.hacktron.ai/platform/repositories/github.md): Configure repository access for GitHub Free, GitHub Team and GitHub Enterprise Cloud.
- [GitHub Enterprise Server](https://docs.hacktron.ai/platform/repositories/github-enterprise-server.md): Configure repository access for a self-hosted GitHub Enterprise Server instance.
- [GitLab](https://docs.hacktron.ai/platform/repositories/gitlab.md): Configure repository access for GitLab.com and self-hosted GitLab.
- [Azure DevOps](https://docs.hacktron.ai/platform/repositories/azure-devops.md): Configure repository access for Azure DevOps Services and Azure DevOps Server.
- [Bitbucket](https://docs.hacktron.ai/platform/repositories/bitbucket.md): Configure repository access for Bitbucket Cloud.
- [Overview](https://docs.hacktron.ai/platform/project-management.md): Connect Jira or Linear so Hacktron can create tickets for approved security findings.
- [Jira](https://docs.hacktron.ai/platform/project-management/jira.md): Connect Jira and configure how Hacktron creates Jira tickets for security findings.
- [Linear](https://docs.hacktron.ai/platform/project-management/linear.md): Connect Linear and configure how Hacktron creates Linear issues for security findings.
- [Overview](https://docs.hacktron.ai/platform/communication-apps.md): Connect communication apps so Hacktron can send security notifications to your team.
- [Slack](https://docs.hacktron.ai/platform/communication-apps/slack.md): Connect Slack and configure where Hacktron sends security notifications.
- [Overview](https://docs.hacktron.ai/platform/context/overview.md): Give Hacktron durable repository and application context for more accurate scans and PR reviews.
- [Applications](https://docs.hacktron.ai/platform/context/applications.md): Group related repositories so Hacktron can reason about them as one product.
- [Threat models](https://docs.hacktron.ai/platform/context/threat-models.md): Understand how Hacktron builds repository and application threat models from code, documents, and triage feedback.
- [Automations](https://docs.hacktron.ai/platform/automations/overview.md): Configure actions that run on triggers. Automate routine work such as remediation.
- [Remediation](https://docs.hacktron.ai/platform/automations/remediation.md): Trigger an AI-generated fix for a finding and receive it as a ready-to-review pull request.
- [Automation credits](https://docs.hacktron.ai/platform/automations/credits.md): Understand how to buy Automation credits, how runs use them, and how auto top-up works.
- [Personal settings](https://docs.hacktron.ai/platform/account-settings.md): Manage your profile, connected accounts, and personal account security.
- [Security settings](https://docs.hacktron.ai/platform/security-settings.md): Configure organization-wide MFA enforcement and SAML Enterprise SSO.
- [Organization settings](https://docs.hacktron.ai/platform/organization-settings.md): Configure scan filters, the check gate, code review comments, and SLA thresholds for your organization.
- [Billing](https://docs.hacktron.ai/platform/billing.md): Trials, seats, and credits across the Hacktron Platform.
- [Privacy](https://docs.hacktron.ai/privacy.md): Learn about how Hacktron protects your data and respects your privacy"
- [Security](https://docs.hacktron.ai/security.md): As security researchers ourselves, we take security seriously.
- [Code Review](https://docs.hacktron.ai/code-review/overview.md): Use Code Review to run continuous pull request security reviews across connected repositories.
- [Setup](https://docs.hacktron.ai/code-review/setup.md): Connect a Git provider, enable repositories, and choose which branches Hacktron should review.
- [Code Review Billing](https://docs.hacktron.ai/code-review/billing.md): Free trial, seats, spillover, and subscription lifecycle for Code Review.
- [People](https://docs.hacktron.ai/code-review/people.md): Configure Code Review seats, assignment mode, and developer access from People.
- [Usage](https://docs.hacktron.ai/code-review/spillover-usage.md): Understand pooled Code Review limits, spillover billing, and active-period usage reporting.
- [Project rules](https://docs.hacktron.ai/code-review/rules.md): Use .hacktron/rules.md to give Hacktron repository-specific review context.
- [Repository configuration](https://docs.hacktron.ai/code-review/config.md): Use .hacktron/config.yaml to control which pull and merge requests Hacktron scans, and when a finding should fail the check.
- [Slack](https://docs.hacktron.ai/code-review/integrations/slack.md): Connect Slack and manage findings from Slack.
- [GitHub / GitLab](https://docs.hacktron.ai/code-review/integrations/github-gitlab.md): Connect GitHub / GitLab to enable Code Review or link your existing Code Review seat.
- [Findings and feedback](https://docs.hacktron.ai/code-review/findings-feedback.md): Understand where Hacktron posts Code Review findings and how feedback improves future reviews.
- [Troubleshooting](https://docs.hacktron.ai/code-review/troubleshooting.md): Check why Hacktron did not review a pull request or merge request.
- [White-box Pentest](https://docs.hacktron.ai/white-box-pentest/overview.md): Run organization-scoped Whitebox Scans from Hacktron using shared scan credits.
- [Quickstart](https://docs.hacktron.ai/white-box-pentest/quickstart.md): Prepare scope, estimate credits, and start a white-box pentest.
- [Credits and billing](https://docs.hacktron.ai/white-box-pentest/billing.md): Understand Whitebox Scan credits, estimates, purchases, deductions, and refunds.
- [Introduction](https://docs.hacktron.ai/api-reference/introduction.md): Programmatic access to Hacktron scans, findings, and cost estimations.
- [Authentication](https://docs.hacktron.ai/api-reference/authentication.md): Create API keys and authenticate requests to the Hacktron REST API.
- [Rate limits](https://docs.hacktron.ai/api-reference/rate-limits.md): Request quotas, 429 behaviour, and how to back off.
- [Pagination, filtering & sorting](https://docs.hacktron.ai/api-reference/pagination-filtering.md): Shared query conventions used by list endpoints.
- [Errors](https://docs.hacktron.ai/api-reference/errors.md): HTTP status codes and error response shapes.
- [Create cost estimation](https://docs.hacktron.ai/api-reference/cost-estimations/create-cost-estimation.md): Estimate the credit cost of scanning one or more repositories before starting a scan.
- [List cost estimations](https://docs.hacktron.ai/api-reference/cost-estimations/list-cost-estimations.md): List cost estimations for your organization.
- [Get cost estimation](https://docs.hacktron.ai/api-reference/cost-estimations/get-cost-estimation.md): Fetch a cost estimation by ID.
- [Trigger a Whitebox Scan](https://docs.hacktron.ai/api-reference/scans/create-scan.md): Start a Whitebox Scan against one or more repositories.
- [List scans](https://docs.hacktron.ai/api-reference/scans/list-scans.md): List scans with pagination, filtering, and sorting.
- [Get scan](https://docs.hacktron.ai/api-reference/scans/get-scan.md): Fetch a single scan, including its findings summary.
- [Get scan status](https://docs.hacktron.ai/api-reference/scans/get-scan-status.md): Lightweight endpoint for polling a scan until it completes.
- [List scan findings](https://docs.hacktron.ai/api-reference/scans/list-scan-findings.md): Paginate through the findings produced by a scan.
- [Export scan findings](https://docs.hacktron.ai/api-reference/scans/export-scan-findings.md): Download all findings for a scan as JSON, CSV, or SARIF.
- [List findings](https://docs.hacktron.ai/api-reference/findings/list-findings.md): List findings across all scans in your organization.
- [Get finding](https://docs.hacktron.ai/api-reference/findings/get-finding.md): Fetch a single finding with full triage context.
- [Update finding](https://docs.hacktron.ai/api-reference/findings/update-finding.md): Change a finding's state, severity, and/or duplicate link.
- [Add finding comment](https://docs.hacktron.ai/api-reference/findings/add-finding-comment.md): Append a comment to a finding's triage thread.
- [Export findings](https://docs.hacktron.ai/api-reference/findings/export-findings.md): Export findings across all scans as JSON, CSV, or SARIF.
- [List repositories](https://docs.hacktron.ai/api-reference/repos/list-repos.md): List repositories from all connected providers.
- [Get package verdict](https://docs.hacktron.ai/api-reference/hfw/get-package-verdict.md): Get a fast dependency verdict for a package.
- [Get scoped npm package verdict](https://docs.hacktron.ai/api-reference/hfw/get-scoped-npm-verdict.md): Get a fast dependency verdict for a scoped npm package.
- [Get batch verdicts](https://docs.hacktron.ai/api-reference/hfw/batch-verdicts.md): Get fast dependency verdicts for many packages at once.
- [List malware feed](https://docs.hacktron.ai/api-reference/hfw/osv-feed.md): List known-malware feed entries.
- [Get Started](https://docs.hacktron.ai/mcp/get-started.md): Choose your platform and copy the config. No API key required.
- [Changelog](https://docs.hacktron.ai/changelog.md): New features, improvements, and fixes to the Hacktron platform.

## OpenAPI Specs

- [openapi](/openapi.json)

## Optional

- [Community](https://discord.gg/eRHCHsvDKh)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.