# HTTP API

Every vulnerability management route, grouped by resource, with the page that explains it.

Base URL: `https://www.vulnes.is/api/site/v1/`. Paths below are written from `/v1`. Every route takes the Resolve Platform session or `Authorization: ApiKey <orgId>:<key>`, and acts on the caller's organisation. A row that belongs to another organisation answers `404`.

A plan-gated route answers `200` with `planLocked: true`, `requiredPlan` and an `_entitlements` marker instead of `403`, so check the body, not only the status.

## Findings

| Method | Path | Explained in |
|---|---|---|
| GET | `/v1/findings/` | [Findings and triage](/vulnerability-management/findings/triage.md) |
| GET | `/v1/findings/metrics` | [Findings and triage](/vulnerability-management/findings/triage.md) |
| GET | `/v1/findings/stats`, `/v1/findings/facets`, `/v1/findings/metric-detail` | dashboard counts |
| GET | `/v1/findings/export` | export of the current filter |
| GET | `/v1/findings/{findingUuid}/enrichment` | |
| GET | `/v1/findings/strategy-lens` | [Risk strategies](/vulnerability-management/prioritisation/risk-strategies.md) |
| PATCH | `/v1/findings/{uuid}/triage` | [Findings and triage](/vulnerability-management/findings/triage.md) |
| PATCH | `/v1/findings/{uuid}/score` | [Findings and triage](/vulnerability-management/findings/triage.md#custom-scores) |
| POST | `/v1/findings/bulk/triage`, `/v1/findings/bulk/score`, `/v1/findings/bulk/suppress` | [Findings and triage](/vulnerability-management/findings/triage.md#bulk-actions) |
| POST | `/v1/findings/{uuid}/github-advisory` | drafts a private GitHub repository advisory from the finding |
| GET | `/v1/scanner-results/finding/{findingUuid}/attack-surface` | [Internet exposure](/vulnerability-management/prioritisation/internet-exposure.md) |

## Review

| Method | Path | Explained in |
|---|---|---|
| GET | `/v1/review/counts`, `/v1/review/findings`, `/v1/review/decisions`, `/v1/review/audit`, `/v1/review/audit/summary` | [Findings and triage](/vulnerability-management/findings/triage.md#awaiting-review) |
| GET, POST | `/v1/review/dependencies` | dependency decisions |

## Suppressions

| Method | Path | Explained in |
|---|---|---|
| GET, POST | `/v1/suppressions` | [Suppressions](/vulnerability-management/findings/suppressions.md) |
| PATCH, DELETE | `/v1/suppressions/{uuid}` | [Suppressions](/vulnerability-management/findings/suppressions.md#changing-a-rule) |

## Prioritisation and policy

| Method | Path | Explained in |
|---|---|---|
| GET, POST | `/v1/risk-strategies/` | [Risk strategies](/vulnerability-management/prioritisation/risk-strategies.md) |
| PUT, DELETE | `/v1/risk-strategies/{id}` | [Risk strategies](/vulnerability-management/prioritisation/risk-strategies.md) |
| PUT | `/v1/risk-strategies/{id}/rules` | [Risk strategies](/vulnerability-management/prioritisation/risk-strategies.md) |
| GET, POST | `/v1/attack-paths/` | [Risk strategies](/vulnerability-management/prioritisation/risk-strategies.md#attack-paths) |
| GET, PUT, DELETE | `/v1/attack-paths/{id}` | |
| PUT | `/v1/attack-paths/{id}/vectors` | |
| GET, PUT | `/v1/triage-policy` | [Remediation policy](/vulnerability-management/prioritisation/remediation-policy.md) |

## Campaigns (Pro and above)

| Method | Path | Explained in |
|---|---|---|
| GET, POST | `/v1/campaigns/` | [Campaigns](/vulnerability-management/campaigns/campaigns.md) |
| POST | `/v1/campaigns/preview` | [Scope and done criteria](/vulnerability-management/campaigns/scope-and-done.md) |
| GET | `/v1/campaigns/contributor-candidates` | [Campaigns](/vulnerability-management/campaigns/campaigns.md#contributors) |
| GET, PATCH, DELETE | `/v1/campaigns/{id}` | [Campaigns](/vulnerability-management/campaigns/campaigns.md) |
| PUT | `/v1/campaigns/{id}/contributors` | |
| POST | `/v1/campaigns/{id}/evaluate` | [Campaigns](/vulnerability-management/campaigns/campaigns.md#evaluation) |
| GET | `/v1/campaigns/{id}/evaluate-status`, `/items`, `/metrics`, `/context`, `/events` | [Campaigns](/vulnerability-management/campaigns/campaigns.md#measures) |

## Repositories

| Method | Path | Explained in |
|---|---|---|
| GET | `/v1/repositories/`, `/v1/repositories/stats`, `/v1/repositories/names`, `/v1/repositories/search` | [Repository scope](/vulnerability-management/scope/repositories.md) |
| POST | `/v1/repositories/resolve` | [Repository scope](/vulnerability-management/scope/repositories.md) |
| GET | `/v1/repositories/detail`, `/facets`, `/scanner-results`, `/findings`, `/dependencies`, `/package-managers`, `/malware`, `/firewall-logs` (all `?fullName=`) | [Repository scope](/vulnerability-management/scope/repositories.md) |
| GET | `/v1/integrations/github/repos/status?repo=` (Resolve Platform session only) | [Repository scope](/vulnerability-management/scope/repositories.md#the-github-app) |

## Graph and labels

| Method | Path | Explained in |
|---|---|---|
| GET | `/v1/insights/graph`, `/v1/insights/graph/{repoId}/nodes`, `/v1/insights/graph/{repoId}/intel`, `/v1/insights/node/{repoId}/{nodeId}`, `/v1/insights/org/metrics` | [Asset relationships](/vulnerability-management/scope/asset-relationships.md) |
| GET, POST | `/v1/threat-model/annotations` | [Asset relationships](/vulnerability-management/scope/asset-relationships.md#labels) |
| PATCH, DELETE | `/v1/threat-model/annotations/{id}` | |
| GET | `/v1/threat-model/annotations/labels` | |
| POST | `/v1/threat-model/annotations/derive` | |
