---
title: "Start a Scan"
method: POST
path: "/api/v2/scan"
tags: ["Public Scan"]
---

# Start a Scan

`POST /api/v2/scan`

## Request

- Base URL: `https://aquilax.ai`
- URL: `https://aquilax.ai/api/v2/scan`
- Auth: API key in header `X-AX-KEY`

Start a new source code scan based on a git code base 🚀

## Query parameters

- `org` string, required
- `group` string, required

## Request body

- object: Data to submit on your request to Securitron
  - `git_uri` string: Git URL to scan
  - `branch` string: Git Branch to Scan, if not set then `main` will be used

## Response `200`

Successful response with a structured text output

## Changes

- **2025-04-01** `2e3eab6fbaa2`: 2 breaking, 2 warning
  - added the new required `query` request parameter `group`
  - added the new required `query` request parameter `org`
  - deleted the `query` request parameter `group_id`
  - deleted the `query` request parameter `organization_id`
- **2025-04-01** `3840864d84de`: 1 info
  - endpoint added
- **2025-03-09** `8e1891ab4552`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs/changes/api/v2/scan/post.md)

---

[API](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs.md) - [All operations](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs/revisions/9b4f595ad674?raw)