# FortWatch API

> The FortWatch REST API (https://api.fortwatch.ai): assets, scans, issues, reports and the audit log of a FortWatch workspace. Authenticate with an API key or an OAuth 2.1 access token in the Authorization header.

## Guides

- [Getting started](https://docs.fortwatch.ai/getting-started.md): Create an API key and make your first request in two minutes.
- [Authentication](https://docs.fortwatch.ai/authentication.md): API keys: what they can reach, how they stop, and how to keep them safe.
- [OAuth apps](https://docs.fortwatch.ai/oauth.md): Connect a product to FortWatch with OAuth 2.1: the authorization code flow with PKCE, refresh tokens, client credentials.
- [Limits and paging](https://docs.fortwatch.ai/limits.md): Request budgets, the per-workspace limits on heavy operations, and how lists are paged.
- [Errors](https://docs.fortwatch.ai/errors.md): The shape of an error and every code the API answers.

## API reference

- [OpenAPI document](https://docs.fortwatch.ai/openapi.json): the whole reference, machine-readable

### Assets

- [List assets](https://docs.fortwatch.ai/api/assets/list-assets.md): GET /app/assets
- [Get an asset](https://docs.fortwatch.ai/api/assets/get-asset.md): GET /app/assets/{id}
- [Get the outside view](https://docs.fortwatch.ai/api/assets/get-asset-outside-view.md): GET /app/assets/{id}/outside-view/{part}
- [Get the ownership state](https://docs.fortwatch.ai/api/assets/get-asset-ownership.md): GET /app/assets/{id}/ownership
- [Get an asset's screenshot](https://docs.fortwatch.ai/api/assets/get-asset-screenshot.md): GET /app/assets/{id}/screenshot
- [Add an asset](https://docs.fortwatch.ai/api/assets/create-asset.md): POST /app/assets
- [Verify ownership](https://docs.fortwatch.ai/api/assets/verify-asset-ownership.md): POST /app/assets/{id}/ownership/verify
- [Check an asset again](https://docs.fortwatch.ai/api/assets/revalidate-asset.md): POST /app/assets/{id}/revalidate
- [Update an asset](https://docs.fortwatch.ai/api/assets/update-asset.md): PUT /app/assets/{id}
- [Delete an asset](https://docs.fortwatch.ai/api/assets/delete-asset.md): DELETE /app/assets/{id}

### Projects

- [List projects](https://docs.fortwatch.ai/api/projects/list-projects.md): GET /app/projects
- [Create a project](https://docs.fortwatch.ai/api/projects/create-project.md): POST /app/projects
- [Update a project](https://docs.fortwatch.ai/api/projects/update-project.md): PUT /app/projects/{id}
- [Delete a project](https://docs.fortwatch.ai/api/projects/delete-project.md): DELETE /app/projects/{id}

### Discovery

- [List discovered hostnames](https://docs.fortwatch.ai/api/discovery/list-discovered-hosts.md): GET /app/discovery/hosts
- [Summarize discovery](https://docs.fortwatch.ai/api/discovery/get-discovery-summary.md): GET /app/discovery/summary
- [Ignore a hostname](https://docs.fortwatch.ai/api/discovery/ignore-discovered-host.md): POST /app/discovery/hosts/{id}/ignore
- [Restore a hostname](https://docs.fortwatch.ai/api/discovery/restore-discovered-host.md): POST /app/discovery/hosts/{id}/restore
- [Add hostnames as assets](https://docs.fortwatch.ai/api/discovery/add-discovered-hosts.md): POST /app/discovery/hosts/add
- [Run discovery](https://docs.fortwatch.ai/api/discovery/run-discovery.md): POST /app/discovery/run

### Scans

- [List scans](https://docs.fortwatch.ai/api/scans/list-scans.md): GET /app/scans
- [Get a scan](https://docs.fortwatch.ai/api/scans/get-scan.md): GET /app/scans/{id}
- [List a scan's findings](https://docs.fortwatch.ai/api/scans/list-scan-findings.md): GET /app/scans/{id}/findings
- [List a scan's issues](https://docs.fortwatch.ai/api/scans/list-scan-issues.md): GET /app/scans/{id}/issues
- [List running scans](https://docs.fortwatch.ai/api/scans/list-active-scans.md): GET /app/scans/active
- [Start a scan](https://docs.fortwatch.ai/api/scans/start-scan.md): POST /app/scans
- [Delete a scan](https://docs.fortwatch.ai/api/scans/delete-scan.md): DELETE /app/scans/{id}

### Scan schedules

- [List scan schedules](https://docs.fortwatch.ai/api/scan-schedules/list-scan-schedules.md): GET /app/scan-schedules
- [Create a scan schedule](https://docs.fortwatch.ai/api/scan-schedules/create-scan-schedule.md): POST /app/scan-schedules
- [Update a scan schedule](https://docs.fortwatch.ai/api/scan-schedules/update-scan-schedule.md): PUT /app/scan-schedules/{id}
- [Delete a scan schedule](https://docs.fortwatch.ai/api/scan-schedules/delete-scan-schedule.md): DELETE /app/scan-schedules/{id}

### Issues

- [List issues](https://docs.fortwatch.ai/api/issues/list-issues.md): GET /app/issues
- [Get an issue](https://docs.fortwatch.ai/api/issues/get-issue.md): GET /app/issues/{id}
- [List an issue's comments](https://docs.fortwatch.ai/api/issues/list-issue-comments.md): GET /app/issues/{id}/comments
- [Comment on an issue](https://docs.fortwatch.ai/api/issues/add-issue-comment.md): POST /app/issues/{id}/comments
- [Assign an issue](https://docs.fortwatch.ai/api/issues/assign-issue.md): PATCH /app/issues/{id}/assignee
- [Edit a comment](https://docs.fortwatch.ai/api/issues/edit-issue-comment.md): PATCH /app/issues/{id}/comments/{commentId}
- [Dismiss an issue](https://docs.fortwatch.ai/api/issues/dismiss-issue.md): PATCH /app/issues/{id}/dismiss
- [Change an issue's status](https://docs.fortwatch.ai/api/issues/set-issue-status.md): PATCH /app/issues/{id}/status
- [Delete a comment](https://docs.fortwatch.ai/api/issues/delete-issue-comment.md): DELETE /app/issues/{id}/comments/{commentId}

### Findings

- [List findings](https://docs.fortwatch.ai/api/findings/list-findings.md): GET /app/findings

### Ports

- [List open ports](https://docs.fortwatch.ai/api/ports/list-open-ports.md): GET /app/ports

### Reports

- [Get the SLA report](https://docs.fortwatch.ai/api/reports/get-sla-report.md): GET /app/reports/sla
- [Get the period summary](https://docs.fortwatch.ai/api/reports/get-report-summary.md): GET /app/reports/summary
- [Get the most vulnerable assets](https://docs.fortwatch.ai/api/reports/get-vulnerable-assets.md): GET /app/reports/vulnerable-assets

### Assessments

- [List assessment reports](https://docs.fortwatch.ai/api/assessments/list-assessments.md): GET /app/assessments
- [Get an assessment report](https://docs.fortwatch.ai/api/assessments/get-assessment.md): GET /app/assessments/{id}
- [Get a report as HTML](https://docs.fortwatch.ai/api/assessments/get-assessment-html.md): GET /app/assessments/{id}/html
- [Get a report as PDF](https://docs.fortwatch.ai/api/assessments/get-assessment-pdf.md): GET /app/assessments/{id}/pdf
- [Create an assessment report](https://docs.fortwatch.ai/api/assessments/create-assessment.md): POST /app/assessments
- [Share a report](https://docs.fortwatch.ai/api/assessments/share-assessment.md): POST /app/assessments/{id}/share
- [Delete a report](https://docs.fortwatch.ai/api/assessments/delete-assessment.md): DELETE /app/assessments/{id}
- [Stop sharing a report](https://docs.fortwatch.ai/api/assessments/unshare-assessment.md): DELETE /app/assessments/{id}/share

### Audit log

- [List audit events](https://docs.fortwatch.ai/api/audit-log/list-audit-events.md): GET /app/audit-log
- [Export the audit log](https://docs.fortwatch.ai/api/audit-log/export-audit-log.md): GET /app/audit-log/export
- [Get the audit log's filters](https://docs.fortwatch.ai/api/audit-log/get-audit-filters.md): GET /app/audit-log/filters