Scan a file or directory

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/endpoint/action/scan
{
  "comment": "Scan the file for malware",
  "endpoint_ids": [
    "ed518850-681a-4d60-bb98-e22640cae2a8"
  ],
  "parameters": {
    "path": "/usr/my-file.txt"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/endpoint/action/scan" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Scan the file for malware",
    "endpoint_ids": [
      "ed518850-681a-4d60-bb98-e22640cae2a8"
    ],
    "parameters": {
      "path": "/usr/my-file.txt"
    }
  }'

Generated from the API spec

Response

No example

Authentication

Request body { }

Response

Request body