---
type: api
title: Scan a file or directory
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v8/operation/operation-endpointscanaction
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v8/operation/operation-endpointscanaction
products:
  - Kibana
---

# Scan a file or directory

- Server: `https://{kibana_url}`

## Paths

- `POST` `/api/endpoint/action/scan`
- `POST` `/s/{space_id}/api/endpoint/action/scan`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v8/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v8/authentication#basicauth)

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Scan a specific file or directory on an endpoint for malware.

## Request Body

`application/json`

- `agent_type` (enum) — optional
  List of agent types to retrieve. Defaults to `endpoint`.
  Values: `endpoint`, `sentinel_one`, `crowdstrike`, `microsoft_defender_endpoint`
- `alert_ids` ([] object · min: 1) — optional
  A list of alerts ids.
- `case_ids` ([] object · min: 1) — optional
  Case IDs to be updated (cannot contain empty strings)
- `comment` (string) — optional
  Optional comment
- `endpoint_ids` ([] object · min: 1) — required
  List of endpoint IDs (cannot contain empty strings)
- `parameters` (object) — required
  Optional parameters object

## Response

OK

`application/json`

Type: `object`

## Code Examples

#### Console

```console
POST /api/endpoint/action/scan
```

#### curl

```curl
curl -X POST "https://{kibana_url}/api/endpoint/action/scan"
```