Skip to main content

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_console from CreateSession (POST /identity/entities/sessions/v1)
  • Authorization: Bearer with api-clients:read for query, get, and accessible scopes
  • api-clients:write for 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:

ScopeUse
user-management:readQuery/get users and roles
user-management:writeMutate users
hosts:readQuery/get hosts
alerts:readQuery/get alerts
alerts:writePatch alert status
host-groups:readQuery/get host groups and members
host-groups:writeMutate host groups and membership
sensors:readQuery/get installer metadata and CCID
installation-tokens:readQuery/get installation tokens
installation-tokens:writeMutate installation tokens
prevention-policies:readQuery/get prevention policies and members
prevention-policies:writeMutate prevention policies, actions, and precedence
response-policies:readQuery/get response policies and members
response-policies:writeMutate response policies, actions, and precedence
sensor-update-policies:readQuery/get sensor update policies and members
sensor-update-policies:writeMutate sensor update policies, actions, and precedence
device-control-policies:readQuery/get device control policies and members
device-control-policies:writeMutate device control policies, actions, and precedence
ioc:readQuery/get IOC indicators
ioc:writeMutate IOC indicators
custom-ioa:readQuery/get Custom IOA rule groups and rules
custom-ioa:writeMutate Custom IOA rule groups and rules
intel:readQuery/get Intel actors and Intel indicators (no write)
spotlight-vulnerabilities:readQuery/get Spotlight vulnerabilities (no write)
quarantine:readQuery/get quarantined files
quarantine:writePATCH release/unrelease/delete
real-time-response:readQuery/get sessions, init, execute ls/pwd, check
event-streams:readList available streams and refresh the active session
kubernetes-protection:readList Kubernetes Protection clusters and cloud locations
cspm-registration:readList CSPM-registered AWS, Azure, and GCP accounts
cloud-aws-registration:readList Cloud AWS Registration accounts
cloud-azure-registration:readList Cloud Azure Registration tenants
cloud-google-cloud-registration:readList Cloud Google Cloud Registration rows
cloud-oci-registration:readList Cloud OCI Registration tenancies
cloud-policies:readList Cloud Policies compliance frameworks
falcon-container-image:readList assessed container images, combined container vulnerabilities, and container registries
api-clients:readQuery/get API clients
api-clients:writeMutate API clients

Unknown scope on create/patch → 400.

HTTP paths​

MethodPathUse
GET/api-clients/queries/api-clients/v1Query 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/v1Create. Body name (optional) and scopes (required). Success 201. Secret in the response once.
PATCH/api-clients/entities/api-clients/v1Update 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=resetReset secret. action_name must be reset else 400. New secret in the response once.
GET/api-clients/entities/accessible-scopes/v1Allowed scope strings.

The secret is never stored plaintext. List and get responses omit it.

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
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).