# Semgrep: API ## API - [API / v2 (Experimental) (229 pages)](https://docs.semgrep.dev/_llms/api/v2-experimental.md): Documentation for API / v2 (Experimental). ### v1 #### Overview - [Semgrep API v1](https://docs.semgrep.dev/api-reference/v1/Introduction.md): Welcome to the portal for Semgrep AppSec Platform's web API. - [Authentication](https://docs.semgrep.dev/api-reference/v1/Authentication.md) - [Terms of Use](https://docs.semgrep.dev/api-reference/v1/Terms-of-Use.md) #### Endpoints ##### Code, Supply Chain, and AI-powered detection - [List code, supply chain, or AI-powered detection findings](https://docs.semgrep.dev/api-reference/v1/findingsservice/list-code-supply-chain-or-ai-powered-detection-findings.md): Request the list of code, supply chain, or AI-powered detection findings in an organization, paginated in pages of 100 entries and limited by the `since` timestamp. Findings are returned by `relevant_since` descending (see `since` in the Query Parameters list). Examples: List SAST findings with pagi… ##### Deployment - [List deployments](https://docs.semgrep.dev/api-reference/v1/deploymentsservice/list-deployments.md): Request the deployments your auth can access. ##### Policies - [List policies](https://docs.semgrep.dev/api-reference/v1/policiesservice/list-policies.md) - [List policy rules](https://docs.semgrep.dev/api-reference/v1/policiesservice/list-policy-rules.md) - [Update policy](https://docs.semgrep.dev/api-reference/v1/policiesservice/update-policy.md) ##### Projects - [Add tags to project](https://docs.semgrep.dev/api-reference/v1/projectsservice/add-tags-to-project.md): Add tags to a project for a deployment you have access to. - [Remove tags from project](https://docs.semgrep.dev/api-reference/v1/projectsservice/remove-tags-from-project.md): Remove tags from a project for a deployment you have access to. - [Get project details](https://docs.semgrep.dev/api-reference/v1/projectsservice/get-project-details.md): Retrieve details for a single project associated with a deployment that you have access to. - [Delete project](https://docs.semgrep.dev/api-reference/v1/projectsservice/delete-project.md): Delete a project for a deployment you have access to. This will also delete all of the associated findings. - [Update project details](https://docs.semgrep.dev/api-reference/v1/projectsservice/update-project-details.md): Update attributes for the project using the value passed in to the request body. - [List all projects](https://docs.semgrep.dev/api-reference/v1/projectsservice/list-all-projects.md): Request the list of projects that have been scanned or onboarded to Managed Scans. Does not return archived repositories. Returns 100 projects per page by default. - [Toggle Managed Scans for a project](https://docs.semgrep.dev/api-reference/v1/projectsservice/toggle-managed-scans-for-a-project.md): Enable or disable [Semgrep Managed Scans](/docs/deployment/managed-scanning/overview) for a project. ##### Scans - [Get scan details](https://docs.semgrep.dev/api-reference/v1/scansservice/get-scan-details.md): Request the details of a scan including the associated deployment, repository, and commit information. - [List scans (beta)](https://docs.semgrep.dev/api-reference/v1/scansservice/list-scans-beta.md): List the scans associated with a particular repository over the past 30 days. ##### Secrets - [List secrets](https://docs.semgrep.dev/api-reference/v1/secretsservice/list-secrets.md) ##### Supply Chain - [Create a new SBOM export job](https://docs.semgrep.dev/api-reference/v1/supplychainservice/create-a-new-sbom-export-job.md) - [Get the status of a SBOM export job](https://docs.semgrep.dev/api-reference/v1/supplychainservice/get-the-status-of-a-sbom-export-job.md) - [List dependencies](https://docs.semgrep.dev/api-reference/v1/supplychainservice/list-dependencies.md) - [List lockfiles in a given repository with dependencies](https://docs.semgrep.dev/api-reference/v1/supplychainservice/list-lockfiles-in-a-given-repository-with-dependencies.md) - [List repositories with dependencies](https://docs.semgrep.dev/api-reference/v1/supplychainservice/list-repositories-with-dependencies.md) ##### Ticketing - [Create Jira tickets](https://docs.semgrep.dev/api-reference/v1/ticketingservice/create-jira-tickets.md): Create Jira tickets for your findings. You can create tickets by passing in a list of issue_ids or by passing in filter query parameters to dynamically select findings. If passing in filters, Semgrep will skip already ticketed findings. This endpoint is synchronous, so it may take some time for your… - [Link an existing ticket to findings](https://docs.semgrep.dev/api-reference/v1/ticketingservice/link-an-existing-ticket-to-findings.md): Link an existing external ticket (e.g. Jira) to one or more Semgrep findings by providing the ticket URL and a list of finding IDs. This does not create a ticket in your issue tracker — it only records the association in Semgrep. If a finding is already linked to a different ticket, the existing lin… - [Unlink a Jira ticket](https://docs.semgrep.dev/api-reference/v1/ticketingservice/unlink-a-jira-ticket.md): Unlink a Jira ticket by its ID - [Unlink a ticket from findings](https://docs.semgrep.dev/api-reference/v1/ticketingservice/unlink-a-ticket-from-findings.md): Remove the ticket association from one or more Semgrep findings by providing a list of finding IDs. This does not delete the ticket in your issue tracker — it only removes the association in Semgrep. ##### Triage - [Bulk triage](https://docs.semgrep.dev/api-reference/v1/triageservice/bulk-triage.md): Bulk triage your findings. You can select the findings to triage by passing in a list of finding IDs as issue_ids, or by passing in filter query parameters. You must specify the issue_type of the findings you want to bulk triage. One of new_triage_state or new_note is required. If specifying a new_t… ##### Other - [[Beta] Get Managed Scans VPC bootstrap CloudFormation template](https://docs.semgrep.dev/api-reference/v1/miscservice/[beta]-get-managed-scans-vpc-bootstrap-cloudformation-template.md): VPC support for Managed Scans is in private beta. - [Ping](https://docs.semgrep.dev/api-reference/v1/miscservice/ping.md): Use to ping the server and assert liveness. ## OpenAPI Specs - [public_v1.openapi](/public_v1.openapi.yaml) - [public_v2.openapi](/public_v2.openapi.yaml)