Semgrep — API

Welcome to Semgrep's portal for the Semgrep AppSec Platform web API.

first call

$ curl "$BASE_URL/api/v1/deployments" \
  -H "Authorization: Bearer $TOKEN"

Set $BASE_URL and $TOKEN first, then paste.

Base URL: Not named in the archived spec. $BASE_URL below stands for the origin you deploy against.
Authenticate: Bearer token in the Authorization header Get access to data with a Semgrep Admin JSON Web Token.

2 other schemes

Bearer token in the Authorization header
Bearer token in the Authorization header
Shape: GET9
POST9
PUT2
PATCH2
DELETE3

What it covers

Projects 7 read, update, delete
Supply Chain 5 Manage the Supply Chain findings and dependencies of your organization.
Ticketing 4 Create and manage external tickets
Policies 3 Deprecated.
Scans 2 View details of scans associated with projects in your organization.
Deployment 1 Deployments encapsulate your organization's security organization, with multiple projects, policies, and integrations.
Code, Supply Chain, and AI-powered detection 1 Manage and retrieve code, supply chain, and AI-powered detection findings from Semgrep scans
Secrets 1 View and manage the Secrets of your organization.
Triage 1 View and manage the triage of your organization.

Open an endpoint for a runnable command, its inputs and what it returns.

DELETE /api/v1/deployments/{deploymentSlug}/projects/{projectName} Delete project

Loading…
DELETE /api/v1/deployments/{deploymentSlug}/projects/{projectName}/tags Remove tags from project

Loading…
GET /api/v1/deployments/{deploymentSlug}/projects List all projects

Loading…
GET /api/v1/deployments/{deploymentSlug}/projects/{projectName} Get project details

Loading…
PATCH /api/v1/deployments/{deploymentSlug}/projects/{projectName} Update project details

Loading…
PATCH /api/v1/deployments/{deploymentSlug}/projects/{projectName}/managed-scan Toggle Managed Scans for a project

Loading…
PUT /api/v1/deployments/{deploymentSlug}/projects/{projectName}/tags Add tags to project

Loading…

GET /api/v1/deployments/{deploymentId}/sbom/export/{taskToken} Get the status of a SBOM export job

Loading…
POST /api/v1/deployments/{deploymentId}/dependencies List dependencies

Loading…
POST /api/v1/deployments/{deploymentId}/dependencies/repositories List repositories with dependencies

Loading…
POST /api/v1/deployments/{deploymentId}/dependencies/repositories/{repositoryId}/lockfiles List lockfiles in a given repository with dependencies

Loading…
POST /api/v1/deployments/{deploymentId}/sbom/export Create a new SBOM export job

Loading…

DELETE /api/v1/deployments/{deploymentId}/ticketing/v2/tickets/{externalTicketId} Unlink a Jira ticket

Loading…
POST /api/v1/deployments/{deploymentId}/tickets/link Link an existing ticket to findings

Loading…
POST /api/v1/deployments/{deploymentId}/tickets/unlink Unlink a ticket from findings

Loading…
POST /api/v1/deployments/{deploymentSlug}/tickets Create Jira tickets

Loading…

GET /api/v1/deployments/{deploymentId}/policies List policies deprecated

Loading…
GET /api/v1/deployments/{deploymentId}/policies/{policyId} List policy rules deprecated

Loading…
PUT /api/v1/deployments/{deploymentId}/policies/{policyId} Update policy deprecated

Loading…

GET /api/v1/deployments/{deploymentId}/scan/{scanId} Get scan details

Loading…
POST /api/v1/deployments/{deploymentId}/scans/search List scans (beta)

Loading…

GET /api/v1/deployments/{deploymentSlug}/findings List code, supply chain, or AI-powered detection findings

Loading…

2026-09-22
- −GET /api/v1/bootstrap-sms-vpc
- −GET /api/v1/ping
2026-08-04
- ⚠GET /api/v1/deployments/{deploymentId}/policies
- ⚠GET /api/v1/deployments/{deploymentId}/policies/{policyId}
- ⚠PUT /api/v1/deployments/{deploymentId}/policies/{policyId}