Real Time Response
Real Time Response is the session collection for this CID — query,
POST GET, init, execute, and check. Paths are under
/real-time-response/…. Batch, files, and admin are not
implemented. Event streams are a separate collection:
Event streams.
This collection is not CrowdStrike production. It does not call Falcon cloud. It is not a live sensor.
RPC field notes: RealTimeResponseService. REST schemas: API reference. Filter syntax: FQL.
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: Bearerwithreal-time-response:readfor query, get, init, execute, and check
Init and execute use real-time-response:read (not a write scope). A
session cookie bypasses OAuth scopes. Seed client cs-local-hosts
(hosts:read only) cannot query sessions (403). There is no seeded
client with real-time-response:read — use the console cookie, or a
client you created with that scope. Missing or revoked token → 401.
HTTP paths
| Method | Path | Use |
|---|---|---|
GET | /real-time-response/queries/sessions/v1 | Query session ids. Query: filter, limit, offset, sort (hostname.asc / hostname.desc). Empty filter returns all ids. |
POST | /real-time-response/entities/sessions/GET/v1 | Get sessions. Body { "ids": [] }. Missing id → 200 with only found resources. |
POST | /real-time-response/entities/sessions/v1 | Init. Body { "device_id": "" }. Success 201. Unknown device → 404. Empty device_id → 400. |
POST | /real-time-response/entities/command/v1 | Execute. Body { "session_id": "", "base_command": "", "command_string": "" }. Success 201. |
GET | /real-time-response/entities/command/v1?cloud_request_id= | Check command status. Empty cloud_request_id → 400. Unknown id → 404. |
Allowed FQL properties: id, aid, hostname (match is lowercase).
aid matches stored device_id. Nested device.hostname is not
accepted. Unknown property or invalid filter → 400.
Session JSON: id, device_id, hostname, origin. Command JSON:
cloud_request_id, session_id, base_command, command_string,
stdout, complete.
Get is POST with a JSON body, like Quarantine GET/v1 — not GET
query ids.
Allowed commands: ls, pwd (base_command and command_string
starting with that token). Others → 400. Execute is synchronous
complete (complete is true). Windows ls stdout is
C:\\ Windows Users. Unknown session → 404.
This is not Quarantine, Hosts, or Event streams. Quarantine uses
/quarantine/…: Quarantine. Hosts uses
/devices/…: Hosts. Event streams uses
/sensors/entities/datafeed/…: Event streams.
Seed session
id | device_id | hostname | origin |
|---|---|---|---|
rtr-sess-lab-1 | aid-win-01 | win-dc-01 | console |
Query matches any stored string for those FQL properties. Same device
may create another session (not a singleton). Init origin is
console.
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 sessions (cookie)
Empty filter returns at least the seed id rtr-sess-lab-1.
hostname:'win-dc-01' returns that row:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/real-time-response/queries/sessions/v1?filter=hostname:%27win-dc-01%27'
Invalid FQL is 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/real-time-response/queries/sessions/v1?filter=not-fql'
Get sessions (cookie)
Get is POST with a JSON body, like user-management GET/v1 — not GET
query ids:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"ids":["rtr-sess-lab-1"]}' \
http://127.0.0.1:8088/real-time-response/entities/sessions/GET/v1
Init session (cookie)
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"device_id":"aid-win-01"}' \
http://127.0.0.1:8088/real-time-response/entities/sessions/v1
Success is 201. Unknown device is 404:
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"device_id":"aid-unknown"}' \
http://127.0.0.1:8088/real-time-response/entities/sessions/v1
Execute command (cookie)
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"session_id":"rtr-sess-lab-1","base_command":"ls","command_string":"ls"}' \
http://127.0.0.1:8088/real-time-response/entities/command/v1
Success is 201. Copy cloud_request_id from resources. Windows ls
stdout is C:\\ Windows Users. Other commands are 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"session_id":"rtr-sess-lab-1","base_command":"put","command_string":"put"}' \
http://127.0.0.1:8088/real-time-response/entities/command/v1
Check command (cookie)
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/real-time-response/entities/command/v1?cloud_request_id=<cloud_request_id>'
complete is true. Stdout matches the execute row.
Batch, files, and admin are not implemented. Quarantine is a separate collection: Quarantine. Spotlight is a separate collection: Spotlight. Event streams is a separate collection: Event streams.
Query (Bearer)
TOKEN='<access_token from a client with real-time-response:read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/real-time-response/queries/sessions/v1'
real-time-response:read → 200. A token without that scope
(including hosts:read only) → 403. Missing or revoked token →
401.
Init (Bearer)
TOKEN='<access_token from a client with real-time-response:read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"device_id":"aid-win-01"}' \
http://127.0.0.1:8088/real-time-response/entities/sessions/v1
real-time-response:read → 201. A token without that scope → 403.
Missing or revoked token → 401.
OAuth2 mint/revoke: OAuth2. Accessible scopes: API clients.