---
title: "Requests to scan a storage"
method: POST
path: "/v1/storages/{storage_id}/scan/"
---

# Requests to scan a storage

`POST /v1/storages/{storage_id}/scan/`

## Request

- Base URL: `https://app.iconik.io/API/files`
- URL: `https://app.iconik.io/API/files/v1/storages/{storage_id}/scan/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-files/docs/v1/storages/:storage_id/scan/post.ts> (a function with typed inputs; its response is checked against the schema)

Required roles:
 - can_scan_bucket

## Path parameters

- `storage_id` string, required

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Request body

- StorageScanSchema
  - `files` string[], nullable
  - `ignore_already_active` boolean: Will force scanning even if the scan is already active if any of `paths` or `files` are specified.
  - `paths` string[], nullable

## Response `201`

Scan started

## Other responses

- `400`: Bad request
- `401`: Token is invalid
- `404`: Storage doesn't exist
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-files.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-files/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-files/revisions/ed57d13791a2?raw)