# Semgrep: API v2 (Experimental) ## v2 (Experimental) ### Overview - [Semgrep API v2](https://docs.semgrep.dev/api-reference/v2/Introduction.md): Welcome to the portal for Semgrep AppSec Platform's web API v2. - [Authentication](https://docs.semgrep.dev/api-reference/v2/Authentication.md) - [Terms of Use](https://docs.semgrep.dev/api-reference/v2/Terms-of-Use.md) ### Endpoints #### AI Fix Jobs - [Create fix job](https://docs.semgrep.dev/api-reference/v2/aifixjobsservice/create-fix-job.md): This feature is currently in Public Beta. #### AI tasks - [Create combined task](https://docs.semgrep.dev/api-reference/v2/aitasksservice/create-combined-task.md): Create a combined task for a deployment - [Create pattern fix task](https://docs.semgrep.dev/api-reference/v2/aitasksservice/create-pattern-fix-task.md): Create a pattern fixing task for a given pattern and language. This is used in the structure mode of the editor - [Get task info](https://docs.semgrep.dev/api-reference/v2/aitasksservice/get-task-info.md): Get the task info for a deployment #### Autofix - [Create autofix](https://docs.semgrep.dev/api-reference/v2/autofixservice/create-autofix.md): This feature is currently in Public Beta. #### Automations - [List automations](https://docs.semgrep.dev/api-reference/v2/automationsservice/list-automations.md): List all automations. - [Create automation](https://docs.semgrep.dev/api-reference/v2/automationsservice/create-automation.md): Create a new automation. - [Update automation](https://docs.semgrep.dev/api-reference/v2/automationsservice/update-automation.md): Update an existing automation. - [Delete automation](https://docs.semgrep.dev/api-reference/v2/automationsservice/delete-automation.md): Delete an automation by its ID. - [List automations](https://docs.semgrep.dev/api-reference/v2/automationsservice/list-automations-1.md): List all automations with pagination support. #### Autotriage Feedback - [Submit autotriage feedback](https://docs.semgrep.dev/api-reference/v2/autotriagefeedbackservice/submit-autotriage-feedback.md): Post autotriage feedback #### Deployment - [List deployment users](https://docs.semgrep.dev/api-reference/v2/deploymentservice/list-deployment-users.md): Get deployment users - [Add deployment user](https://docs.semgrep.dev/api-reference/v2/deploymentservice/add-deployment-user.md): Add a user to the deployment - [Create deployment](https://docs.semgrep.dev/api-reference/v2/deploymentservice/create-deployment.md): Create adeployment - [Get deployment](https://docs.semgrep.dev/api-reference/v2/deploymentservice/get-deployment.md): Get a deployment - [Update deployment](https://docs.semgrep.dev/api-reference/v2/deploymentservice/update-deployment.md): Update a deployment - [Get deployment authorized actions](https://docs.semgrep.dev/api-reference/v2/deploymentservice/get-deployment-authorized-actions.md): Get a list of actions the user is authorized to take on the deployment - [Get deployment default user role](https://docs.semgrep.dev/api-reference/v2/deploymentservice/get-deployment-default-user-role.md): Get the default user role for a deployment - [Get deployment for current token](https://docs.semgrep.dev/api-reference/v2/deploymentservice/get-deployment-for-current-token.md): Get all deployments for a token - [Get deployment GitHub app status](https://docs.semgrep.dev/api-reference/v2/deploymentservice/get-deployment-github-app-status.md): Check if the Semgrep GitHub app is installed for the deployment - [List deployment users (paginated)](https://docs.semgrep.dev/api-reference/v2/deploymentservice/list-deployment-users-paginated.md): List deployment users (paginated) - [Remove deployment user](https://docs.semgrep.dev/api-reference/v2/deploymentservice/remove-deployment-user.md): Remove a user from the deployment - [Send product toggle feedback](https://docs.semgrep.dev/api-reference/v2/deploymentservice/send-product-toggle-feedback.md): Submit feedback about enabling or disabling a product for the deployment. - [Toggle cross-file analysis](https://docs.semgrep.dev/api-reference/v2/deploymentservice/toggle-cross-file-analysis.md): Enable or disable cross-file analysis for the deployment's scans. - [Toggle dependency query](https://docs.semgrep.dev/api-reference/v2/deploymentservice/toggle-dependency-query.md): Enable or disable dependency querying for the deployment. - [Toggle triage via comment](https://docs.semgrep.dev/api-reference/v2/deploymentservice/toggle-triage-via-comment.md): Enable or disable triaging findings by replying to Semgrep's review comments. - [Update deployment user role](https://docs.semgrep.dev/api-reference/v2/deploymentservice/update-deployment-user-role.md): Change the organization role assigned to a user in the deployment. #### Deployment Products - [Get deployment product config](https://docs.semgrep.dev/api-reference/v2/deploymentproductsservice/get-deployment-product-config.md): Get the product configuration for a deployment - [Create or update deployment product config](https://docs.semgrep.dev/api-reference/v2/deploymentproductsservice/create-or-update-deployment-product-config.md): Create or update the product configuration for a deployment - [Get deployment admin product config](https://docs.semgrep.dev/api-reference/v2/deploymentproductsservice/get-deployment-admin-product-config.md): Get the admin product configuration for a deployment #### Deployment SSO Providers - [List deployment SSO providers](https://docs.semgrep.dev/api-reference/v2/deploymentssoprovidersservice/list-deployment-sso-providers.md): List all SSO providers for a deployment #### Deployment Tags - [Get a deployment tag](https://docs.semgrep.dev/api-reference/v2/deploymenttagservice/get-a-deployment-tag.md): Get a deployment tag - [Create or update a deployment tag](https://docs.semgrep.dev/api-reference/v2/deploymenttagservice/create-or-update-a-deployment-tag.md): Create or update a deployment tag - [Delete a deployment tag](https://docs.semgrep.dev/api-reference/v2/deploymenttagservice/delete-a-deployment-tag.md): Delete a deployment tag - [Find deployment tags with project counts](https://docs.semgrep.dev/api-reference/v2/deploymenttagservice/find-deployment-tags-with-project-counts.md): Find deployment tags with project counts - [List deployment tags](https://docs.semgrep.dev/api-reference/v2/deploymenttagservice/list-deployment-tags.md): List deployment tags #### Deployments - [List deployments](https://docs.semgrep.dev/api-reference/v2/deploymentsservice/list-deployments.md): Request the deployments your auth can access. #### Editor - [Run pattern](https://docs.semgrep.dev/api-reference/v2/editorservice/run-pattern.md): Execute a Semgrep pattern against target code and return the results #### External Ticketing - [Create external tickets](https://docs.semgrep.dev/api-reference/v2/externalticketingservice/create-external-tickets.md): Create tickets in your issue tracking system for Semgrep findings. - [Delete external ticket](https://docs.semgrep.dev/api-reference/v2/externalticketingservice/delete-external-ticket.md): Delete a ticket and unlink it from Semgrep findings. - [Get external ticketing instances](https://docs.semgrep.dev/api-reference/v2/externalticketingservice/get-external-ticketing-instances.md): Gets the issue tracking systems linked to a deployment. E.g. Jira. - [Link an existing ticket to findings](https://docs.semgrep.dev/api-reference/v2/externalticketingservice/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 ticket from findings](https://docs.semgrep.dev/api-reference/v2/externalticketingservice/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. #### Feature Rollouts - [List available feature rollouts](https://docs.semgrep.dev/api-reference/v2/featurerolloutsservice/list-available-feature-rollouts.md): List all available feature rollouts #### Global Ignores - [Get product ignores](https://docs.semgrep.dev/api-reference/v2/ignoresservice/get-product-ignores.md): Get the global ignore patterns configured for each product in a deployment. - [Create product ignores](https://docs.semgrep.dev/api-reference/v2/ignoresservice/create-product-ignores.md): Add global ignore patterns for one or more products in a deployment. - [Delete product ignores](https://docs.semgrep.dev/api-reference/v2/ignoresservice/delete-product-ignores.md): Remove the global ignore patterns for one or more products in a deployment. - [Update product ignores](https://docs.semgrep.dev/api-reference/v2/ignoresservice/update-product-ignores.md): Update the global ignore patterns for one or more products in a deployment. #### Infrastructure Configurations - [Get Managed Scans VPC bootstrap CloudFormation template](https://docs.semgrep.dev/api-reference/v2/infrastructureconfigurationsservice/get-managed-scans-vpc-bootstrap-cloudformation-template.md): VPC support for Managed Scans is in private beta. #### Issues - [Bulk update issues](https://docs.semgrep.dev/api-reference/v2/issuesservice/bulk-update-issues.md): Bulk triage issues that match specified filters - [Export issues](https://docs.semgrep.dev/api-reference/v2/issuesservice/export-issues.md): Asynchronously export issues matching filters to a file - [Get issue](https://docs.semgrep.dev/api-reference/v2/issuesservice/get-issue.md): Get a single issue by ID with details - [Get issue code snippets](https://docs.semgrep.dev/api-reference/v2/issuesservice/get-issue-code-snippets.md): Get code snippets for an issue. - [Get issue counts](https://docs.semgrep.dev/api-reference/v2/issuesservice/get-issue-counts.md): Get counts of issues by status with filtering - [Get issue filters](https://docs.semgrep.dev/api-reference/v2/issuesservice/get-issue-filters.md): Get available filter options for issues - [List issue groups](https://docs.semgrep.dev/api-reference/v2/issuesservice/list-issue-groups.md): Search and group issues by rule with filtering and pagination - [List issues](https://docs.semgrep.dev/api-reference/v2/issuesservice/list-issues.md): List an organization's recent issues with filtering, sorting, and pagination #### Issues (Semgrep Agentic Workflows) - [Count issues](https://docs.semgrep.dev/api-reference/v2/publicissuesservice/count-issues.md): Count Semgrep Agentic Workflows issues matching the supplied filters. - [Get issue activity history](https://docs.semgrep.dev/api-reference/v2/publicissuesservice/get-issue-activity-history.md): Get a page of activity history for a Semgrep Agentic Workflows issue, newest first. - [Get issue by ID](https://docs.semgrep.dev/api-reference/v2/publicissuesservice/get-issue-by-id.md): Get a Semgrep Agentic Workflows issue by ID. - [Triage issue](https://docs.semgrep.dev/api-reference/v2/publicissuesservice/triage-issue.md): Set the triage state and reason for a Semgrep Agentic Workflows issue. - [Search issues](https://docs.semgrep.dev/api-reference/v2/publicissuesservice/search-issues.md): Search Semgrep Agentic Workflows issues with filtering, sorting, and cursor pagination. #### Managed Scan Settings - [Get Semgrep Managed Scan settings](https://docs.semgrep.dev/api-reference/v2/managedscansettingsservice/get-semgrep-managed-scan-settings.md): Get the Managed Scan settings that apply to all of a deployment's Managed Scans. - [Create Semgrep Managed Scan settings](https://docs.semgrep.dev/api-reference/v2/managedscansettingsservice/create-semgrep-managed-scan-settings.md): Create the Managed Scan settings for a deployment. - [Update Semgrep Managed Scan settings](https://docs.semgrep.dev/api-reference/v2/managedscansettingsservice/update-semgrep-managed-scan-settings.md): Replace an existing set of Managed Scan settings. - [Delete Semgrep Managed Scan settings](https://docs.semgrep.dev/api-reference/v2/managedscansettingsservice/delete-semgrep-managed-scan-settings.md): Delete a set of Managed Scan settings by ID. #### Memories - [Create memory](https://docs.semgrep.dev/api-reference/v2/memoriesservice/create-memory.md): Create a new memory. - [Create memory from triage](https://docs.semgrep.dev/api-reference/v2/memoriesservice/create-memory-from-triage.md): Create a new memory from a triage event. - [Update memory](https://docs.semgrep.dev/api-reference/v2/memoriesservice/update-memory.md): Update a memory by replacement. - [Delete memory](https://docs.semgrep.dev/api-reference/v2/memoriesservice/delete-memory.md): Delete a memory by its ID. - [Find relevant issues](https://docs.semgrep.dev/api-reference/v2/memoriesservice/find-relevant-issues.md): Find relevant issues for a given rule and repository. - [Get memories by IDs](https://docs.semgrep.dev/api-reference/v2/memoriesservice/get-memories-by-ids.md): Get memories by ids. - [Get memory statistics](https://docs.semgrep.dev/api-reference/v2/memoriesservice/get-memory-statistics.md): Get statistics about a deployment's memories performance - [List memories](https://docs.semgrep.dev/api-reference/v2/memoriesservice/list-memories.md): List memories, optionally scoped to a single repository. - [List suggested memories](https://docs.semgrep.dev/api-reference/v2/memoriesservice/list-suggested-memories.md): List all suggested memories. #### Notification Rules - [Create notification rule](https://docs.semgrep.dev/api-reference/v2/notificationrulesservice/create-notification-rule.md): Create a notification rule - [Replace notification rule](https://docs.semgrep.dev/api-reference/v2/notificationrulesservice/replace-notification-rule.md): Replace a notification rule - [Delete notification rule](https://docs.semgrep.dev/api-reference/v2/notificationrulesservice/delete-notification-rule.md): Delete a notification rule - [List notification rules](https://docs.semgrep.dev/api-reference/v2/notificationrulesservice/list-notification-rules.md): List notification rules - [Test notification rule](https://docs.semgrep.dev/api-reference/v2/notificationrulesservice/test-notification-rule.md): Test a notification rule #### Notification Webhooks - [List notification webhooks](https://docs.semgrep.dev/api-reference/v2/notificationwebhooksservice/list-notification-webhooks.md): List all notification webhooks for a deployment. - [Create notification webhook](https://docs.semgrep.dev/api-reference/v2/notificationwebhooksservice/create-notification-webhook.md): Create a new webhook endpoint. - [Get notification webhook](https://docs.semgrep.dev/api-reference/v2/notificationwebhooksservice/get-notification-webhook.md): Get a specific notification webhook by ID. - [Update notification webhook](https://docs.semgrep.dev/api-reference/v2/notificationwebhooksservice/update-notification-webhook.md): Update a notification webhook by replacement. - [Delete notification webhook](https://docs.semgrep.dev/api-reference/v2/notificationwebhooksservice/delete-notification-webhook.md): Delete a notification webhook by its ID. - [Test notification webhook](https://docs.semgrep.dev/api-reference/v2/notificationwebhooksservice/test-notification-webhook.md): Send a test payload to the webhook endpoint. #### Notifications - [List unread notifications](https://docs.semgrep.dev/api-reference/v2/notificationsservice/list-unread-notifications.md): Returns a paginated list of unread notifications for a particular viewer - [Mark notifications as seen](https://docs.semgrep.dev/api-reference/v2/notificationsservice/mark-notifications-as-seen.md): Marks a list of notifications as seen #### Onboarding Checklist - [Get onboarding checklist status](https://docs.semgrep.dev/api-reference/v2/checklistservice/get-onboarding-checklist-status.md): Get the completion status of each task in a deployment's onboarding checklist. - [Update onboarding checklist](https://docs.semgrep.dev/api-reference/v2/checklistservice/update-onboarding-checklist.md): Update the completion status of tasks in a deployment's onboarding checklist. - [Invite members](https://docs.semgrep.dev/api-reference/v2/checklistservice/invite-members.md): Invite users to a deployment as part of the onboarding checklist. #### Policies - [List policies](https://docs.semgrep.dev/api-reference/v2/policiesservice/list-policies.md): List all policies for a given deployment. - [List policy rules](https://docs.semgrep.dev/api-reference/v2/policiesservice/list-policy-rules.md): List the rules for a given policy. - [Update policy rule](https://docs.semgrep.dev/api-reference/v2/policiesservice/update-policy-rule.md): Update a specific rule within a policy. #### Policies V2 - [Get a detection policy](https://docs.semgrep.dev/api-reference/v2/policiesv2service/get-a-detection-policy.md): Returns the detection policy bundle for one product (`code` or `secrets`), including its exceptions, plus the state_version required to apply changes. Returns 404 with code PRODUCT_NOT_ENABLED when the requested product is not enabled for the deployment. - [Apply a detection policy](https://docs.semgrep.dev/api-reference/v2/policiesv2service/apply-a-detection-policy.md): Strictly applies a candidate detection policy bundle for one product: the submitted bundle replaces the current state, and exceptions absent from it are deleted. Requires the current state_version in the If-Match header; responds 428 when the header is missing and 409 with the current state_version… - [Get remediation policies](https://docs.semgrep.dev/api-reference/v2/policiesv2service/get-remediation-policies.md): Returns the remediation policies bundle for the deployment plus the state_version required to apply changes. System-managed policies are not included. - [Apply remediation policies](https://docs.semgrep.dev/api-reference/v2/policiesv2service/apply-remediation-policies.md): Strictly applies a candidate remediation policies bundle: the submitted list replaces the current state, and policies absent from it are deleted. Requires the current state_version in the If-Match header; responds 428 when the header is missing and 409 with the current state_version when it is stale… - [Get the detection policy summary](https://docs.semgrep.dev/api-reference/v2/policiesv2service/get-the-detection-policy-summary.md): Returns the detection policy bundles and state_versions for every enabled product in one read-only call. Writes always go through the per-product endpoints. - [Get the policy vocabulary](https://docs.semgrep.dev/api-reference/v2/policiesv2service/get-the-policy-vocabulary.md): Returns the condition types, action types, and value enums this API accepts, so bundles can be validated client-side (for example in CI) without a round trip. Without the product query parameter, only the product-agnostic vocabulary is returned; pass product to include its value enums and, for `code… - [Preview a detection policy apply](https://docs.semgrep.dev/api-reference/v2/policiesv2service/preview-a-detection-policy-apply.md): Validates a candidate detection policy bundle and returns the diff a strict apply would produce, without changing anything. The response includes the state_version the diff was computed against; send that exact value as If-Match on the follow-up PUT to guarantee you apply the diff you previewed. - [Preview a remediation policies apply](https://docs.semgrep.dev/api-reference/v2/policiesv2service/preview-a-remediation-policies-apply.md): Validates a candidate remediation policies bundle and returns the diff a strict apply would produce, without changing anything. The response includes the state_version the diff was computed against; send that exact value as If-Match on the follow-up PUT to guarantee you apply the diff you previewed. #### Projects - [Add Semgrep CI secrets to GitHub repositories](https://docs.semgrep.dev/api-reference/v2/projectsservice/add-semgrep-ci-secrets-to-github-repositories.md): Generates and adds a secret for the "semgrep-ci" GitHub Action to the GitHub Repositories that are associated with any Semgrep Projects that match the given filters. - [Bulk edit projects by filter](https://docs.semgrep.dev/api-reference/v2/projectsservice/bulk-edit-projects-by-filter.md): Applies a change to many projects that match the given filters. - [Bulk edit selected projects](https://docs.semgrep.dev/api-reference/v2/projectsservice/bulk-edit-selected-projects.md): Applies changes to multiple specified projects at once. - [Get project](https://docs.semgrep.dev/api-reference/v2/projectsservice/get-project.md): Get a project by its ID. - [Delete project](https://docs.semgrep.dev/api-reference/v2/projectsservice/delete-project.md): Delete a project by its ID. This will delete the project and all of its findings. This action cannot be reversed. - [Get branch](https://docs.semgrep.dev/api-reference/v2/projectsservice/get-branch.md): Get a branch by its ID. - [Get project count](https://docs.semgrep.dev/api-reference/v2/projectsservice/get-project-count.md): Get the number of projects in a deployment. - [List project IDs by tag](https://docs.semgrep.dev/api-reference/v2/projectsservice/list-project-ids-by-tag.md): Gets a mapping from tag ID to related project IDs. - [List projects](https://docs.semgrep.dev/api-reference/v2/projectsservice/list-projects.md): List all projects based on provided filters. - [Provision Semgrep CI GitHub Actions](https://docs.semgrep.dev/api-reference/v2/projectsservice/provision-semgrep-ci-github-actions.md): Adds a "semgrep-ci" GitHub Action to the GitHub Repositories that are associated with any Semgrep Projects that match the given filters. - [Sync all projects to SCM](https://docs.semgrep.dev/api-reference/v2/projectsservice/sync-all-projects-to-scm.md): Schedules a job to sync all projects in a deployment to their SCM. - [Sync project to SCM](https://docs.semgrep.dev/api-reference/v2/projectsservice/sync-project-to-scm.md): Schedules a job to sync a project with its SCM. - [Update project](https://docs.semgrep.dev/api-reference/v2/projectsservice/update-project.md): Use a "Merge Patch" to update a project's name or SMS settings. #### Projects - Managed Scan Settings - [Bulk get many projects' Managed Scan settings](https://docs.semgrep.dev/api-reference/v2/projectmanagedscansettingsservice/bulk-get-many-projects-managed-scan-settings.md): Finds the user-configurable Managed Scan settings for the specified projects. Projects without Managed Scans set up will have empty values. - [Get a project's Managed Scan settings](https://docs.semgrep.dev/api-reference/v2/projectmanagedscansettingsservice/get-a-projects-managed-scan-settings.md): Finds the user-configurable Managed Scan settings for the specified project. Returns an empty result if the specified project does not have Managed Scans set up. #### Reporting - [Get backlog by product report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-backlog-by-product-report.md) - [Get backlog by rule report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-backlog-by-rule-report.md) - [Get backlog by severity report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-backlog-by-severity-report.md) - [Get findings activity report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-findings-activity-report.md) - [Get findings by project and product report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-findings-by-project-and-product-report.md) - [Get findings by project and severity report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-findings-by-project-and-severity-report.md) - [Get findings funnel report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-findings-funnel-report.md) - [Get guardrails activity report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-guardrails-activity-report.md) - [Get guardrails adoption report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-guardrails-adoption-report.md) - [Get Malware Firewall blocked malicious dependencies by advisory report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-malware-firewall-blocked-malicious-dependencies-by-advisory-report.md) - [Get Malware Firewall blocked malicious dependencies by dependency, version, and ecosystem report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-malware-firewall-blocked-malicious-dependencies-by-dependency-version-and-ecosystem-report.md) - [Get Malware Firewall blocked malicious dependencies by ecosystem report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-malware-firewall-blocked-malicious-dependencies-by-ecosystem-report.md) - [Get Malware Firewall scan activity report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-malware-firewall-scan-activity-report.md) - [Get Malware Firewall summary report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-malware-firewall-summary-report.md) - [Get median open age by product report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-median-open-age-by-product-report.md) - [Get median open age by severity report](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-median-open-age-by-severity-report.md) - [Get report findings](https://docs.semgrep.dev/api-reference/v2/reportsservice/get-report-findings.md) #### Review Comment Product Content - [List review comment product content](https://docs.semgrep.dev/api-reference/v2/reviewcommentproductcontentservice/list-review-comment-product-content.md): List all review comment product contents - [Create review comment product content](https://docs.semgrep.dev/api-reference/v2/reviewcommentproductcontentservice/create-review-comment-product-content.md): Create a new review comment product content - [Update review comment product content](https://docs.semgrep.dev/api-reference/v2/reviewcommentproductcontentservice/update-review-comment-product-content.md): Update an existing review comment product content - [Delete review comment product content](https://docs.semgrep.dev/api-reference/v2/reviewcommentproductcontentservice/delete-review-comment-product-content.md): Delete a review product content by its ID. #### Ruleboards - [List ruleboards](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/list-ruleboards.md) - [Create ruleboard](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/create-ruleboard.md): Create a new ruleboard for the deployment. - [Get ruleboard](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/get-ruleboard.md) - [Update ruleboard](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/update-ruleboard.md) - [Delete ruleboard](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/delete-ruleboard.md): Delete a ruleboard for the deployment. - [Get ruleboard finding counts](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/get-ruleboard-finding-counts.md) - [Get ruleboard overview](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/get-ruleboard-overview.md) - [Update ruleboard overview](https://docs.semgrep.dev/api-reference/v2/ruleboardservice/update-ruleboard-overview.md): buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME #### Scans - [Get scan](https://docs.semgrep.dev/api-reference/v2/scansservice/get-scan.md): Get a scan by ID. - [List scans](https://docs.semgrep.dev/api-reference/v2/scansservice/list-scans.md): List the scans associated with a particular project from the past 30 days. - [Retry failed Managed Scans](https://docs.semgrep.dev/api-reference/v2/scansservice/retry-failed-managed-scans.md): Retry one or more failed Semgrep Managed Scans (SMS). Only scans that are SMS and have failed or never finished can be retried. Send a single scan ID or multiple; returns one task per successful retry and one error per failed retry. #### Semgrep Agentic Workflows - [Get workflow job findings](https://docs.semgrep.dev/api-reference/v2/semgrepworkflowsservice/get-workflow-job-findings.md): Returns the findings produced by a completed workflow job. - [Get workflow job overview](https://docs.semgrep.dev/api-reference/v2/semgrepworkflowsservice/get-workflow-job-overview.md): Returns run-level metadata and a registry-derived step skeleton for a workflow job, without listing run artifacts — a fast first paint. Pair with GetWorkflowJobGraph to stream live step/task status separately. - [List available workflow types](https://docs.semgrep.dev/api-reference/v2/semgrepworkflowsservice/list-available-workflow-types.md): Returns the catalog of workflow types available to trigger for a deployment. - [List workflow jobs](https://docs.semgrep.dev/api-reference/v2/semgrepworkflowsservice/list-workflow-jobs.md): Lists workflow jobs for a deployment, with support for filtering, sorting, and cursor-based pagination. - [Trigger a workflow run](https://docs.semgrep.dev/api-reference/v2/semgrepworkflowsservice/trigger-a-workflow-run.md): Submits a workflow job for a deployment. #### Slack - [Get Slack installation details](https://docs.semgrep.dev/api-reference/v2/slackservice/get-slack-installation-details.md): Retrieves Slack app installation details for a deployment - [Delete Slack installation](https://docs.semgrep.dev/api-reference/v2/slackservice/delete-slack-installation.md): Deletes Slack app installation and revokes access token - [Get Slack app installation URL](https://docs.semgrep.dev/api-reference/v2/slackservice/get-slack-app-installation-url.md): Generates the OAuth URL that initiates the Slack app installation flow - [Get Slack channel mappings](https://docs.semgrep.dev/api-reference/v2/slackservice/get-slack-channel-mappings.md): Retrieves channel mappings for Slack channels - [Get Slack notification mappings](https://docs.semgrep.dev/api-reference/v2/slackservice/get-slack-notification-mappings.md): Retrieves notification mappings for Slack channels - [Handle Slack OAuth callback](https://docs.semgrep.dev/api-reference/v2/slackservice/handle-slack-oauth-callback.md): Processes OAuth callback, exchanges code for access token, and stores installation data #### Source Code Management (SCM) apps - [Add Azure DevOps project](https://docs.semgrep.dev/api-reference/v2/scmappsservice/add-azure-devops-project.md): Add a new ADO project to an existing Entra App install. The service principal must already have permissions on the ADO project - [Complete Azure DevOps SCM app install](https://docs.semgrep.dev/api-reference/v2/scmappsservice/complete-azure-devops-scm-app-install.md): After the user has uploaded the certificate, verify the Service Principal can authenticate to ADO and create webhook subscriptions required for the integration. Then mark the install as ready. - [Complete SCM app request](https://docs.semgrep.dev/api-reference/v2/scmappsservice/complete-scm-app-request.md): Complete an SCM app request. - [Create Azure DevOps SCM app (Service Principal)](https://docs.semgrep.dev/api-reference/v2/scmappsservice/create-azure-devops-scm-app-service-principal.md): Create an ADO ScmApp using Entra ID Service Principal credentials. Generates a key pair server-side and returns the public certificate for the customer to upload to their Entra app registration. CompleteAdoScmAppInstall must be called to finish the install after the certificate is uploaded. - [Create SCM app request](https://docs.semgrep.dev/api-reference/v2/scmappsservice/create-scm-app-request.md): Create a new SCM app request. - [Delete SCM app](https://docs.semgrep.dev/api-reference/v2/scmappsservice/delete-scm-app.md): Delete an SCM app by its ID. - [Get public GitHub app status](https://docs.semgrep.dev/api-reference/v2/scmappsservice/get-public-github-app-status.md): Get the status of a public GitHub App. - [Get SCM app](https://docs.semgrep.dev/api-reference/v2/scmappsservice/get-scm-app.md): Get an SCM app by its request ID. - [List SCM apps](https://docs.semgrep.dev/api-reference/v2/scmappsservice/list-scm-apps.md): List all SCM apps for a deployment. - [Rotate SCM app webhook secret](https://docs.semgrep.dev/api-reference/v2/scmappsservice/rotate-scm-app-webhook-secret.md): Generate a new webhook secret, update it on the SCM provider, and persist it. #### Source Code Management (SCM) configurations - [Check SCM config](https://docs.semgrep.dev/api-reference/v2/scmservice/check-scm-config.md): Check the status of an SCM config. - [List SCM configs](https://docs.semgrep.dev/api-reference/v2/scmservice/list-scm-configs.md): List all SCM configs for a deployment. - [Create SCM config](https://docs.semgrep.dev/api-reference/v2/scmservice/create-scm-config.md): Create a new SCM config. - [Delete SCM config](https://docs.semgrep.dev/api-reference/v2/scmservice/delete-scm-config.md): Delete an SCM config by its ID. - [Update SCM config](https://docs.semgrep.dev/api-reference/v2/scmservice/update-scm-config.md): Update an existing SCM config. - [Search SCM configs](https://docs.semgrep.dev/api-reference/v2/scmservice/search-scm-configs.md): Search for SCM configs for a deployment. - [Sync SCM config](https://docs.semgrep.dev/api-reference/v2/scmservice/sync-scm-config.md): Sync an SCM config. #### Source Code Management (SCM) webhooks - [List SCM webhook subscriptions](https://docs.semgrep.dev/api-reference/v2/scmsubscriptionsservice/list-scm-webhook-subscriptions.md): List all SCM webhook subscriptions for a deployment. - [Subscribe to SCM webhook](https://docs.semgrep.dev/api-reference/v2/scmsubscriptionsservice/subscribe-to-scm-webhook.md): Subscribe to SCM webhook events. - [Unsubscribe from SCM webhook](https://docs.semgrep.dev/api-reference/v2/scmsubscriptionsservice/unsubscribe-from-scm-webhook.md): Unsubscribe from SCM webhook events. - [Rotate SCM webhook secret](https://docs.semgrep.dev/api-reference/v2/scmsubscriptionsservice/rotate-scm-webhook-secret.md): Generate a new webhook secret, update it on the SCM provider, and persist it. #### Supply Chain - [Generate a project's SBOM](https://docs.semgrep.dev/api-reference/v2/supplychain2service/generate-a-projects-sbom.md): Starts a job to asynchronously generate a Software Bill of Materials (SBOM) for a given project. It does not return the SBOM itself, only schedules the job and returns a task JWT. - [List dependencies](https://docs.semgrep.dev/api-reference/v2/supplychain2service/list-dependencies.md): Returns all (or filtered) dependencies for a deployment using pagination - [List dependencies](https://docs.semgrep.dev/api-reference/v2/supplychain2service/list-dependencies-1.md): Returns all (or filtered) dependencies for a deployment using pagination - [List findings for advisory](https://docs.semgrep.dev/api-reference/v2/supplychain2service/list-findings-for-advisory.md): Returns a summary of findings grouped by project and branch for a specific advisory using pagination - [List lockfiles with dependencies in a given repository](https://docs.semgrep.dev/api-reference/v2/supplychain2service/list-lockfiles-with-dependencies-in-a-given-repository.md): Returns all (or filtered) lockfiles that contain dependencies within the specified repository - [List repositories with dependencies](https://docs.semgrep.dev/api-reference/v2/supplychain2service/list-repositories-with-dependencies.md): Returns any repositories which contain dependencies that match the given filter for a deployment #### Supply Chain - Managed Scans dependency resolution configurations - [Get SCA resolution configs](https://docs.semgrep.dev/api-reference/v2/smsscaresolutionconfigservice/get-sca-resolution-configs.md): Retrieve custom dependency resolution configurations for a given deployment and repository. #### Supply Chain - Managed Scans package manager configurations - [List package manager auth configs](https://docs.semgrep.dev/api-reference/v2/smspackagemanagerconfigservice/list-package-manager-auth-configs.md): Retrieve all package manager authentication configurations for a deployment. - [Create package manager auth config](https://docs.semgrep.dev/api-reference/v2/smspackagemanagerconfigservice/create-package-manager-auth-config.md): Create a new package manager authentication configuration for a deployment. - [Delete package manager auth config](https://docs.semgrep.dev/api-reference/v2/smspackagemanagerconfigservice/delete-package-manager-auth-config.md): Delete a package manager authentication configuration. - [Update package manager auth config](https://docs.semgrep.dev/api-reference/v2/smspackagemanagerconfigservice/update-package-manager-auth-config.md): Update an existing package manager authentication configuration. #### Support - [Create support case](https://docs.semgrep.dev/api-reference/v2/supportservice/create-support-case.md): File a new support case. - [List support cases](https://docs.semgrep.dev/api-reference/v2/supportservice/list-support-cases.md): List the support cases filed by an organization. #### Surveys - [Get a company survey response](https://docs.semgrep.dev/api-reference/v2/surveysservice/get-a-company-survey-response.md): Retrieves company survey response by survey name - [Submit company survey response](https://docs.semgrep.dev/api-reference/v2/surveysservice/submit-company-survey-response.md): Responds to company survey #### Tasks - [Get task result](https://docs.semgrep.dev/api-reference/v2/tasksservice/get-task-result.md): Returns the status of a task or task group, and if completed, the result. #### Teams - [Check RBAC status](https://docs.semgrep.dev/api-reference/v2/teamsservice/check-rbac-status.md): Indicates if deployment has Role-Based Access Control enabled - [Create a deployment RBAC team](https://docs.semgrep.dev/api-reference/v2/teamsservice/create-a-deployment-rbac-team.md): Create a new Role-Based Access Control team for a deployment - [Get a deployment RBAC team](https://docs.semgrep.dev/api-reference/v2/teamsservice/get-a-deployment-rbac-team.md): Get a deployment's Role-Based Access Control team - [Delete a deployment RBAC team](https://docs.semgrep.dev/api-reference/v2/teamsservice/delete-a-deployment-rbac-team.md): Delete a deployment's Role-Based Access Control team - [Update a deployment RBAC team](https://docs.semgrep.dev/api-reference/v2/teamsservice/update-a-deployment-rbac-team.md): Update a deployment team's name, users, and repositories - [List an RBAC team's child teams](https://docs.semgrep.dev/api-reference/v2/teamsservice/list-an-rbac-teams-child-teams.md): List the child teams assigned to a Role-Based Access Control team - [List an RBAC team's repositories](https://docs.semgrep.dev/api-reference/v2/teamsservice/list-an-rbac-teams-repositories.md): List the repositories assigned to a Role-Based Access Control team - [List an RBAC team's users](https://docs.semgrep.dev/api-reference/v2/teamsservice/list-an-rbac-teams-users.md): List the users assigned to a Role-Based Access Control team - [List deployment teams](https://docs.semgrep.dev/api-reference/v2/teamsservice/list-deployment-teams.md): List a deployment's Role-Based Access Control teams #### Tokens - [Delete tokens](https://docs.semgrep.dev/api-reference/v2/tokenservice/delete-tokens.md): Delete all tokens matching the given filters #### Users - [Get user](https://docs.semgrep.dev/api-reference/v2/usersservice/get-user.md): Get basic information about a User, like role, email, and auth details - [Get user settings](https://docs.semgrep.dev/api-reference/v2/usersservice/get-user-settings.md): Get basic settings & onboarding info for a user, like contact preferences and product tour state. - [Update user settings](https://docs.semgrep.dev/api-reference/v2/usersservice/update-user-settings.md): Update user settings and preferences for the current user - [List authorized resources](https://docs.semgrep.dev/api-reference/v2/usersservice/list-authorized-resources.md): List all orgnizations/deployments that are available to a user - [List joinable organizations](https://docs.semgrep.dev/api-reference/v2/usersservice/list-joinable-organizations.md): List all organizations/deployments that a user can join - [List user organizations](https://docs.semgrep.dev/api-reference/v2/usersservice/list-user-organizations.md): List all organizations/deployments that a user is a member of #### Versions - [Get project version info](https://docs.semgrep.dev/api-reference/v2/versionsservice/get-project-version-info.md): Get Semgrep version information for recent scans #### Wiz Credentials - [List Wiz credentials](https://docs.semgrep.dev/api-reference/v2/wizcredentialservice/list-wiz-credentials.md): List all Wiz credentials for a deployment. - [Create Wiz credential](https://docs.semgrep.dev/api-reference/v2/wizcredentialservice/create-wiz-credential.md): Create a Wiz credential for a deployment. - [Get Wiz credential](https://docs.semgrep.dev/api-reference/v2/wizcredentialservice/get-wiz-credential.md): Get a single Wiz credential by ID. - [Update Wiz credential](https://docs.semgrep.dev/api-reference/v2/wizcredentialservice/update-wiz-credential.md): Replace an existing Wiz credential. - [Delete Wiz credential](https://docs.semgrep.dev/api-reference/v2/wizcredentialservice/delete-wiz-credential.md): Delete a Wiz credential by ID. - [Validate Wiz credential](https://docs.semgrep.dev/api-reference/v2/wizcredentialservice/validate-wiz-credential.md): Check that a Wiz credential can authenticate against Wiz. #### Other - [Check container health](https://docs.semgrep.dev/api-reference/v2/miscservice/check-container-health.md): Check if container is healthy - [Check container readiness](https://docs.semgrep.dev/api-reference/v2/miscservice/check-container-readiness.md): Check if container started up correctly - [Get identity](https://docs.semgrep.dev/api-reference/v2/miscservice/get-identity.md): Returns the agent's bearer identity - [Get IP](https://docs.semgrep.dev/api-reference/v2/miscservice/get-ip.md): Returns the current IP address - [Get tenant](https://docs.semgrep.dev/api-reference/v2/miscservice/get-tenant.md): Returns the current tenant name for the server (e.g. default) - [Ping](https://docs.semgrep.dev/api-reference/v2/miscservice/ping.md): Responds with pong ## OpenAPI Specs - [public_v2.openapi](/public_v2.openapi.yaml)