---
title: "Scan Repository"
method: POST
path: "/api/v1/scan"
tags: ["scan"]
---

# Scan Repository

`POST /api/v1/scan`

## Request

- Base URL: `https://api.qualityclouds.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.qualityclouds.ai/api/v1/scan`
- Auth: one of:
  - HTTP bearer
  - OpenID Connect (`https://account.qualityclouds.com//realms/ai-production/.well-known/openid-configuration`)

Escanea un repositorio basado en su ID

Args:
    request (ScanRequest): Request con el ID del repositorio a escanear
    repository_scanner (RepositoryScanner): Scanner inyectado por dependencias
    
Returns:
    ScanResponse: Resultado del escaneo
    :param credentials:
    :param repository_scanner:
    :param scan_request:

## Request body

- ScanRequest: Modelo para la petición de escaneo de repositorio Attributes: repository_id (int): ID del repositorio a escanear
  - `repository_id` integer, required

## Response `200`

Successful Response

- ScanResponse: Modelo para la respuesta del escaneo de repositorio Attributes: status (str): Estado del escaneo (success/error) message (str): Mensaje descriptivo del resultado repository_id (int): ID del repositorio escaneado scan_id (str): ID único del escaneo timestamp (str): Timestamp del escaneo
  - `status` string, required
  - `message` string, required
  - `repository_id` integer, required
  - `scan_id` string, required
  - `timestamp` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Validation Error

---

[API](https://skmtc.dev/qualityclouds/apis/qai-orchestrator-api.md) · [All operations](https://skmtc.dev/qualityclouds/apis/qai-orchestrator-api/llms.txt) · [OpenAPI document](https://skmtc.dev/qualityclouds/apis/qai-orchestrator-api/revisions/250c849925af?raw)