Skip to main content

Overview

Call the platform over HTTP. JSON request and response bodies.

This REST surface is not CrowdStrike production. Base URL on Compose is http://crowdstrike-api.localhost:8088 (or http://127.0.0.1:8088 with Host: crowdstrike-api.localhost).

Open the REST API reference →

The reference is Redoc over the generated spec: every path, parameter, and response schema. The machine-readable spec is also GET /openapi.json on this developer site (/openapi.json).

Collections​

Product collections (OAuth2, Hosts, Quarantine, and the rest) are listed on the Developer Center home. Open a collection page for curls, scopes, and seed ids.

GET /api/hello is the HelloService sample. It is not a Falcon collection.

Example (OAuth2 + hosts)​

TOKEN='<access_token from POST /oauth2/token>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/devices/queries/devices/v1'

cs-local-hosts (hosts:read) can query hosts. Quarantine needs quarantine:read. Real Time Response needs real-time-response:read. Event streams needs event-streams:read. Kubernetes Protection needs kubernetes-protection:read. CSPM AWS needs cspm-registration:read (CSPM AWS). CSPM Azure needs cspm-registration:read (CSPM Azure). Container images needs falcon-container-image:read (Container images). Missing token → 401. Wrong scope → 403.

Hello sample (not the product API)​

curl -sS -H 'Host: crowdstrike-api.localhost' \
http://127.0.0.1:8088/api/hello