API clients
API clients are OAuth clients for this CID. Paths are under
/api-clients/…. Seeded clients from console login still work:
cs-local-read (user-management:read) and cs-local-hosts
(hosts:read).
This collection is not CrowdStrike production. It does not call Falcon cloud.
RPC field notes: IdentityService. REST schemas: API reference. Filter syntax: FQL. Mint a token with a client secret: OAuth2.
These curls use Host: crowdstrike-api.localhost against Compose
Traefik on :8088. If the hostname already resolves to Traefik, you can
omit the Host header and call http://crowdstrike-api.localhost instead.
Auth
Every call needs a console session or a Bearer token:
- Cookie
cs_consolefromCreateSession(POST /identity/entities/sessions/v1) Authorization: Bearerwithapi-clients:readfor query, get, and accessible scopesapi-clients:writefor create, patch, delete, and secret reset
A session cookie bypasses OAuth scopes. Seed clients do not include
api-clients:read — use the console cookie, or a client you created with
that scope.
Scopes
GET /api-clients/entities/accessible-scopes/v1 returns:
| Scope | Use |
|---|---|
user-management:read | Query/get users and roles |
user-management:write | Mutate users |
hosts:read | Query/get hosts |
alerts:read | Query/get alerts |
alerts:write | Patch alert status |
host-groups:read | Query/get host groups and members |
host-groups:write | Mutate host groups and membership |
sensors:read | Query/get installer metadata and CCID |
installation-tokens:read | Query/get installation tokens |
installation-tokens:write | Mutate installation tokens |
prevention-policies:read | Query/get prevention policies and members |
prevention-policies:write | Mutate prevention policies, actions, and precedence |
response-policies:read | Query/get response policies and members |
response-policies:write | Mutate response policies, actions, and precedence |
sensor-update-policies:read | Query/get sensor update policies and members |
sensor-update-policies:write | Mutate sensor update policies, actions, and precedence |
device-control-policies:read | Query/get device control policies and members |
device-control-policies:write | Mutate device control policies, actions, and precedence |
ioc:read | Query/get IOC indicators |
ioc:write | Mutate IOC indicators |
custom-ioa:read | Query/get Custom IOA rule groups and rules |
custom-ioa:write | Mutate Custom IOA rule groups and rules |
intel:read | Query/get Intel actors and Intel indicators (no write) |
spotlight-vulnerabilities:read | Query/get Spotlight vulnerabilities (no write) |
quarantine:read | Query/get quarantined files |
quarantine:write | PATCH release/unrelease/delete |
real-time-response:read | Query/get sessions, init, execute ls/pwd, check |
event-streams:read | List available streams and refresh the active session |
kubernetes-protection:read | List Kubernetes Protection clusters and cloud locations |
cspm-registration:read | List CSPM-registered AWS, Azure, and GCP accounts |
cloud-aws-registration:read | List Cloud AWS Registration accounts |
cloud-azure-registration:read | List Cloud Azure Registration tenants |
cloud-google-cloud-registration:read | List Cloud Google Cloud Registration rows |
cloud-oci-registration:read | List Cloud OCI Registration tenancies |
cloud-policies:read | List Cloud Policies compliance frameworks |
falcon-container-image:read | List assessed container images, combined container vulnerabilities, and container registries |
api-clients:read | Query/get API clients |
api-clients:write | Mutate API clients |
Unknown scope on create/patch → 400.
HTTP paths
| Method | Path | Use |
|---|---|---|
GET | /api-clients/queries/api-clients/v1 | Query ids. Query: filter on client_id. Empty filter returns all ids. |
GET | /api-clients/entities/api-clients/v1?ids= | Get clients (id, name, scopes — no secret). |
POST | /api-clients/entities/api-clients/v1 | Create. Body name (optional) and scopes (required). Success 201. Secret in the response once. |
PATCH | /api-clients/entities/api-clients/v1 | Update client_id, optional name, scopes. |
DELETE | /api-clients/entities/api-clients/v1?ids= | Delete. Tokens for that client then 401. |
POST | /api-clients/entities/api-clients-actions/v1?ids=&action_name=reset | Reset secret. action_name must be reset else 400. New secret in the response once. |
GET | /api-clients/entities/accessible-scopes/v1 | Allowed scope strings. |
The secret is never stored plaintext. List and get responses omit it.
Session cookie
curl -sS -c cookies.txt -H 'Host: crowdstrike-api.localhost' \
-H 'Content-Type: application/json' \
-d '{"email":"[email protected]","password":"FalconLocal!1","cloud":"us-1"}' \
http://127.0.0.1:8088/identity/entities/sessions/v1
Query and get (cookie)
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/api-clients/queries/api-clients/v1?filter=client_id:%27cs-local-read%27'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/api-clients/entities/api-clients/v1?ids=cs-local-read'
Query (Bearer)
TOKEN='<access_token from a client with api-clients:read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/api-clients/queries/api-clients/v1'
api-clients:read → 200. Token without that scope → 403. Missing
or revoked token → 401.
Create (secret once)
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"name":"temp-read","scopes":["user-management:read"]}' \
http://127.0.0.1:8088/api-clients/entities/api-clients/v1
Copy client_id and secret from resources. Then mint a token:
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'client_id=<client_id>&client_secret=<secret>' \
http://127.0.0.1:8088/oauth2/token
Reset secret
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/api-clients/entities/api-clients-actions/v1?ids=<client_id>&action_name=reset'
The new secret is in the response once. Tokens minted with the old secret
are 401. Create/reset/delete need api-clients:write (or a session).