---
title: "Run Pattern"
method: POST
path: "/api/run"
tags: ["EditorService"]
---

# Run Pattern

`POST /api/run`

Execute a Semgrep pattern against target code and return the results

## Request body

- ProtosEditorV1RunPatternRequest
  - `pattern` string
  - `target` string
  - `language` string
  - `isDeep` boolean
  - `isDebug` boolean

## Response `200`

OK

- ProtosEditorV1RunPatternResponse
  - `semgrep_result` ProtosEditorV1SemgrepResultData
    - `status_code` integer
    - `output` object
    - `run_error` ProtosEditorV1SemgrepRunExceptionData
      - `message` string
      - `type` string
      - `extra` object
      - `uid` string
    - `run_time` number, double
    - `environment` string
  - `test_result` ProtosEditorV1TestCaseData[]
    - `must_match` boolean
    - `line_no` integer
    - `rule_id` string
    - `status` string
    - `message` string
  - `ai_autofixes` string[]

---

[API](https://skmtc.net/semgrep/apis/semgrep-web-app.md) · [All operations](https://skmtc.net/semgrep/apis/semgrep-web-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/semgrep/semgrep-web-app/revisions/6483eeecd582/schema)