> ## Documentation Index > Fetch the complete documentation index at: https://docs.semgrep.dev/llms.txt > Use this file to discover all available pages before exploring further. # Preview a remediation policies apply > 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. ## OpenAPI ````yaml /public_v2.openapi.yaml post /api/policies/v2/deployments/{deploymentId}/remediation-policies:dryRun openapi: 3.0.3 info: title: Semgrep API description: >- The API v2 is currently a work in progress as we expand and improve our platform capabilities. There are no current plans to deprecate the [v1 API](/api/v1/docs) – we remain committed to supporting existing integrations and will ensure that all v1 use cases are fully supported in v2 before any deprecation occurs. ## API Maturity Levels Each endpoint in the v2 API is marked with a maturity badge to help you understand its current state: 🚧 **Experimental** - Use at your own risk. This endpoint was not originally designed for third-party use or is under active development. Expect significant breaking changes. ⚠️ **Beta** - This endpoint is being refined. We will communicate breaking changes to Beta partners as we tweak the implementation. ✅ **Stable** - No breaking changes will be made to this API. You can confidently build production integrations against these endpoints. We recommend using Stable endpoints for production applications and treating Experimental/Beta endpoints as previews of upcoming functionality. This API is documented in the **OpenAPI format**. # Authentication The API supports authentication with an API token with the "Web API" permission, without limited scopes of access. You can provision an API token [from the Settings page](https://semgrep.dev/orgs/-/settings/tokens). # Terms of Use Please note, the materials made available herein are subject to the [Semgrep Terms of Use](https://semgrep.dev/resources/website-terms/), and your access or use of any of the same is your acknowledgment and acceptance of the such terms.
___ contact: email: support@semgrep.com version: v2.0.0.alpha x-logo: url: https://semgrep.dev/images/SemgrepLogoWithTextWithMargin.svg backgroundColor: '#fafafa' altText: Semgrep logo servers: [] security: [] tags: - name: AiFixJobsService description: Manage AI fix jobs for automated security fixes x-displayName: AI Fix Jobs x-group: AI Fix Jobs - name: AiTasksService description: Manage AI tasks, such as triage, auto-triage, and issue tagging backfill x-displayName: Ai Tasks x-group: Ai Tasks - name: AutofixService description: Trigger automated fixes for SAST, AI SAST, and SCA issues. x-displayName: Autofix x-group: Autofix - name: AutomationsService description: >- Automations are a way to automatically take actions on findings based on certain conditions. x-displayName: Automations x-group: Automations - name: AutotriageFeedbackService description: Feedback for the quality of autotriage, guidance or autofix x-displayName: Autotriage Feedback x-group: Autotriage Feedback - name: ChecklistService description: Manage onboarding checklist x-displayName: Onboarding Checklist x-group: Onboarding Checklist - name: DeploymentProductsService description: Manage deployment product configurations. x-displayName: Deployment Products x-group: Deployment Products - name: DeploymentService description: Manage deployment and its resources. x-displayName: Deployment x-group: Deployment - name: DeploymentSsoProvidersService description: Manage Deployment SSO Providers x-displayName: Deployment SSO Providers x-group: Deployment SSO Providers - name: DeploymentTagService description: Assign tags to a deployment. x-displayName: Deployment Tags x-group: Deployment Tags - name: DeploymentsService description: >- Deployments encapsulate your organization's security organization, with multiple projects, policies, and integrations. As the root object of the organization, they're similarly the root object of the API. x-displayName: Deployments x-group: Deployments - name: EditorService description: Run Semgrep patterns against target code in the editor playground x-displayName: Editor x-group: Editor - name: ExternalTicketingService description: APIs that power the External Ticketing experience. x-displayName: External Ticketing x-group: External Ticketing - name: FeatureRolloutsService description: View feature flags rolled out to all deployments x-displayName: Feature Rollouts x-group: Feature Rollouts - name: IgnoresService description: >- API for managing global ignores. See https://semgrep.dev/docs/ignoring-files-folders-code x-displayName: Global Ignores x-group: Global Ignores - name: InfrastructureConfigurationsService description: Infrastructure configuration information. x-displayName: Infrastructure Configurations x-group: Infrastructure Configurations - name: IssuesService description: Manage findings found by Semgrep scans x-displayName: Issues x-group: Issues - name: ManagedScanSettingsService description: Settings that affect all of a deployment's managed scans x-displayName: Managed Scan Settings x-group: Managed Scan Settings - name: MemoriesService description: Memories help reduce noise from findings. x-displayName: Memories x-group: Memories - name: MiscService description: Miscellaneous endpoints x-displayName: Misc x-group: Misc - name: NotificationRulesService description: Setup rules to get notified about new findings x-displayName: Notification Rules x-group: Notification Rules - name: NotificationWebhooksService description: Manage webhook endpoints for deployment notifications. x-displayName: Notification Webhooks x-group: Notification Webhooks - name: NotificationsService description: Notifications show in-app toasts to users. x-displayName: Notifications x-group: Notifications - name: PoliciesService description: >- View and manage the Policies of your organization. Deployments on the Unified Policies model use the [Policies V2 API](/api/v2/docs/#tag/PoliciesV2Service) instead; this service stops working after the migration. x-displayName: Policies x-group: Policies - name: PoliciesV2Service description: >- Declarative management of detection and remediation policies for deployments on the Unified Policies model. Designed for GitOps-style reconciliation: read the current bundle, edit it, preview the diff with a dry run, then apply it strictly with optimistic concurrency control. x-displayName: Policies V2 x-group: Policies V2 - name: ProjectManagedScanSettingsService description: Settings that affect a specific project's managed scans x-displayName: Projects – Managed Scan Settings x-group: Projects – Managed Scan Settings - name: ProjectsService description: >- Projects are groups of files that are scanned by Semgrep. These normally correspond to repositories. x-displayName: Projects x-group: Projects - name: ReportsService description: APIs for Reporting Dashboards x-displayName: Reporting x-group: Reporting - name: ReviewCommentProductContentService description: >- Review comment product content is a way to add additional per-product information to a review comment. x-displayName: Review Comment Product Content x-group: Review Comment Product Content - name: RuleboardService description: >- The [Policies API](/api/v2/docs/#tag/PoliciesService) is *strongly* recommended. It is also newer than this Ruleboard service. Deployments on the Unified Policies model use the [Policies V2 API](/api/v2/docs/#tag/PoliciesV2Service) instead; this service stops working after the migration. Manage Ruleboards (sets of policies). x-displayName: Ruleboards x-group: Ruleboards - name: ScansService description: View details of scans associated with projects in your organization. x-displayName: Scans x-group: Scans - name: ScmAppsService description: >- Manage connections to source code management systems (Github, Gitlab, etc.) x-displayName: Source Code Management (SCM) App x-group: Source Code Management (SCM) App - name: ScmService description: >- Manage connections to source code management systems (Github, Gitlab, etc.) x-displayName: Source Code Management (SCM) Configs x-group: Source Code Management (SCM) Configs - name: ScmSubscriptionsService description: Manage SCM Webhook Subscriptions x-displayName: Source Code Management (SCM) Webhooks x-group: Source Code Management (SCM) Webhooks - name: SlackService - name: SmsPackageManagerConfigService description: >- Manage authentication configurations for package managers used in Supply Chain Analysis (SCA) scans. x-displayName: Supply Chain - SMS Package Manager Configurations x-group: Supply Chain - SMS Package Manager Configurations - name: SmsScaResolutionConfigService description: >- Retrieve custom dependency resolution configurations for lockfileless scans. x-displayName: Supply Chain - SMS SCA Resolution Configurations x-group: Supply Chain - SMS SCA Resolution Configurations - name: SupplyChain2Service description: >- The Supply Chain is all of the dependencies of code, rather than the code itself. This service gives information about the supply chain. x-displayName: Supply Chain x-group: Supply Chain - name: SupportService description: Create and List Support Cases x-displayName: Support Service x-group: Support Service - name: SurveysService description: Retrieve and submit company surveys x-displayName: Surveys x-group: Surveys - name: TasksService description: >- Many tasks are done asynchronously; this service deals with managing async tasks. x-displayName: Tasks x-group: Tasks - name: TeamsService description: >- Teams are used to manage access control for resources within a deployment. For more information visit https://semgrep.dev/docs/deployment/teams. x-displayName: Teams x-group: Teams - name: TokenService description: >- Tokens are used for programmatic access to the Semgrep Cloud Platform APIs. x-displayName: Tokens x-group: Tokens - name: UsersService description: Manage user accounts, settings, and organization memberships x-displayName: Users Auth Service x-group: Users Auth Service - name: VersionsService description: Semgrep version information x-displayName: Versions x-group: Versions - name: WizCredentialService description: Manage Wiz credentials x-displayName: Wiz Credentials x-group: Wiz Credentials paths: /api/policies/v2/deployments/{deploymentId}/remediation-policies:dryRun: post: tags: - PoliciesV2Service summary: Preview a remediation policies apply description: >- 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. operationId: PoliciesV2Service_DryRunRemediationPolicies parameters: - name: deploymentId in: path required: true schema: example: 1234 title: Deployment ID type: integer description: The unique numerical identifier for the deployment. format: int64 requestBody: content: application/json: schema: $ref: >- #/components/schemas/protos.policies.v2.DryRunRemediationPoliciesRequest required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/protos.policies.v2.DryRunRemediationPoliciesResponse security: - SemgrepWebToken: [] components: schemas: protos.policies.v2.DryRunRemediationPoliciesRequest: title: Dry Run Remediation Policies Request required: - deployment_id - bundle type: object properties: bundle: allOf: - $ref: >- #/components/schemas/protos.policies.v2.RemediationPoliciesBundle description: The candidate bundle to diff against the current state. protos.policies.v2.DryRunRemediationPoliciesResponse: type: object properties: creates: type: array items: $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyDiffEntry' description: Remediation policies that the apply would create. updates: type: array items: $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyDiffEntry' description: Remediation policies that the apply would update. deletes: type: array items: $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyDiffEntry' description: Remediation policies that the apply would delete. state_version: example: d4c3b2a1 type: string description: >- The state_version the diff was computed against. Send this exact value as the If-Match header on the follow-up PUT. validation_errors: type: array items: $ref: '#/components/schemas/protos.policies.v2.BundleValidationError' description: >- Validation problems with the candidate bundle. When non-empty, the diff fields are empty and a strict apply would be rejected. protos.policies.v2.RemediationPoliciesBundle: title: Remediation Policies Bundle type: object properties: deployment_slug: example: my-org type: string description: >- Output only. The slug of the deployment the bundle belongs to. Ignored when sent in a request body. policies: type: array items: $ref: '#/components/schemas/protos.policies.v2.RemediationPolicy' description: The remediation policies of the deployment. description: >- The full declared set of remediation policies for a deployment. A strict apply replaces the whole list: policies absent from the submitted bundle are deleted. System-managed policies never appear in the bundle and are never affected by an apply. protos.policies.v2.RemediationPolicyDiffEntry: type: object properties: kind: example: RemediationPolicy type: string description: The resource the entry refers to. Always `RemediationPolicy`. key: allOf: - $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyDiffKey' description: The stable identity of the policy the entry refers to. before: allOf: - $ref: '#/components/schemas/protos.policies.v2.RemediationPolicy' description: The current content of the policy. Absent on creates. after: allOf: - $ref: '#/components/schemas/protos.policies.v2.RemediationPolicy' description: The content the apply would write. Absent on deletes. description: One entry of a remediation policies diff. protos.policies.v2.BundleValidationError: type: object properties: code: example: UNSUPPORTED_ACTION_TYPE type: string description: >- A stable, machine-readable error code, for example `UNSUPPORTED_ACTION_TYPE` or `UNKNOWN_REFERENCE`. message: type: string description: A human-readable explanation of the problem. policy_slug: type: string description: >- The slug of the remediation policy the error applies to, when scoped to a single policy. Empty for bundle-wide errors. context: type: object additionalProperties: type: string description: >- Structured detail for the error; the keys present depend on `code` (for example `action_type`, `missing_companion`, `condition_type`, `value`). description: |- A single problem found while validating a candidate bundle. A dry run reports every problem it finds at once, so a GitOps client can fix a whole bundle in one round trip rather than one error per dry run. When a dry run returns any validation_errors, the diff fields are empty: the candidate is not applyable until every error is resolved, and a strict apply of the same bundle would fail with the first error's code. protos.policies.v2.RemediationPolicy: title: Remediation Policy required: - name - filters - actions type: object properties: slug: example: block-high-confidence-criticals type: string description: >- The stable public identity of the policy. Immutable after create: renames change name but never slug. When omitted on create, it is derived from name; set it explicitly to pin a URL-safe identity independent of name. name: example: Block high-confidence criticals type: string description: The display name of the policy. description: type: string description: An optional free-form description of the policy. active: example: true type: boolean description: >- Whether the policy is evaluated. Defaults to `true` when omitted on create. filters: allOf: - $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyFilters' description: >- The conditions a finding must match for the policy's actions to fire. actions: type: array items: $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyAction' description: >- The actions that fire when a finding matches. The list is replaced as a unit on update: any change to it is a single update of the policy. description: >- A remediation policy: conditions that fire actions when a finding matches. protos.policies.v2.RemediationPolicyDiffKey: type: object properties: slug: example: block-high-confidence-criticals type: string description: The slug of the policy. description: The stable identity of a remediation policy in a diff. protos.policies.v2.RemediationPolicyFilters: title: Remediation Policy Filters required: - mode type: object properties: mode: example: all type: string description: 'How the conditions combine. One of: `all`, `any`.' conditions: type: array items: $ref: '#/components/schemas/protos.policies.v2.RemediationPolicyCondition' description: >- The conditions evaluated against each finding. At least one condition is required. description: How a remediation policy decides whether a finding matches. protos.policies.v2.RemediationPolicyAction: title: Remediation Policy Action required: - type type: object properties: type: example: block type: string description: >- The action type. One of: `block`, `pr_comment`, `jira`, `slack_app`, `webhook`, `triage`. The vocab endpoint lists the accepted types and their companion requirements (for example, `block` requires `pr_comment` in the same policy). config: type: object additionalProperties: type: string description: >- Action-specific configuration. Downstream resources are referenced by slug or name, never by numeric id. For example, a `jira` action takes `project_id` and `credential_slug`. description: A single action of a remediation policy. protos.policies.v2.RemediationPolicyCondition: title: Remediation Policy Condition required: - type - values type: object properties: type: example: severity type: string description: >- The condition type, for example `severity`, `confidence`, or `repository_tag`. The vocab endpoint lists the accepted types. values: example: - critical - high type: array items: type: string description: The values the condition matches against. mode: example: any type: string description: >- How multiple values combine. One of: `any`, `none`. `none` negates the condition (the finding must match none of the values). Defaults to `any`. description: A single condition of a remediation policy. securitySchemes: SemgrepWebToken: type: http description: >- Get access to data with your API token. Example header: `Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628` The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling `Web API` access. scheme: bearer bearerFormat: string ````