Skip to main content

Quarantine

Quarantine is the quarantined-file collection for this CID — query, POST GET, and PATCH by ids. Paths are under /quarantine/…. Aggregates and update-by-query are not implemented.

This collection is not CrowdStrike production. It does not call Falcon cloud.

RPC field notes: QuarantineService. 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_console from CreateSession (POST /identity/entities/sessions/v1)
  • Authorization: Bearer with quarantine:read for query and get
  • quarantine:write for patch (release / unrelease / delete)

A session cookie bypasses OAuth scopes. Seed client cs-local-hosts (hosts:read only) cannot query quarantined files (403). Unit tests use a client named cs-local-quarantine; that client is not in the production seed. There is no seeded client with quarantine:read — use the console cookie, or a client you created with that scope. Missing or revoked token → 401.

HTTP paths​

MethodPathUse
GET/quarantine/queries/quarantined-files/v1Query file ids. Query: filter, limit, offset, sort (hostname.asc / hostname.desc / sha256.asc / state.asc and matching .desc). Empty filter returns all ids.
POST/quarantine/entities/quarantined-files/GET/v1Get files. Body { "ids": [] }. Missing id → 200 with only found resources.
PATCH/quarantine/entities/quarantined-files/v1Update. Body { "ids": [], "action": "release|unrelease|delete" }. Empty ids → 400. Unknown action → 400.

Allowed FQL properties: hostname, sha256, state (match is lowercase). Nested device.hostname is not accepted. Unknown property or invalid filter → 400.

File JSON: id, hostname, sha256, state, username.

Get is POST with a JSON body, like Intel indicators GET/v1 — not GET query ids.

release sets state to released. unrelease sets state to quarantined. delete removes the row.

This is not Spotlight, Intel, or custom IOC. Spotlight uses /spotlight/…: Spotlight. Intel indicators use POST GET /intel/…: Intel indicators. Custom IOC uses /iocs/…: IOC indicators. Real Time Response uses /real-time-response/…: Real Time Response.

Seed files​

idhostnamesha256stateusername
qf-lab-1lab-win-164×cquarantinedada
qf-lab-2lab-mac-164×dquarantinedada

Query matches any stored string for those FQL properties.

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

Empty filter returns at least the seed ids qf-lab-1 and qf-lab-2. hostname:'lab-win-1' returns the Windows row. state:'quarantined' returns both:

curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/quarantine/queries/quarantined-files/v1?filter=hostname:%27lab-win-1%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/quarantine/queries/quarantined-files/v1?filter=not-fql'

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":["qf-lab-1"]}' \
http://127.0.0.1:8088/quarantine/entities/quarantined-files/GET/v1
curl -sS -X PATCH -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"ids":["qf-lab-1"],"action":"release"}' \
http://127.0.0.1:8088/quarantine/entities/quarantined-files/v1

Get again. qf-lab-1 shows state released:

curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"ids":["qf-lab-1"]}' \
http://127.0.0.1:8088/quarantine/entities/quarantined-files/GET/v1

Patch needs quarantine:write (or a session). A token with only quarantine:read → 403 on PATCH.

Aggregates and update-by-query are not implemented. Spotlight is a separate collection: Spotlight. Intel indicators are a separate POST GET collection: Intel indicators. Custom IOC is a separate collection: IOC indicators. Real Time Response is a separate collection: Real Time Response.

Query (Bearer)​

TOKEN='<access_token from a client with quarantine:read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/quarantine/queries/quarantined-files/v1'

quarantine:read → 200. A token without that scope (including hosts:read only) → 403. Missing or revoked token → 401.

Patch (Bearer)​

TOKEN='<access_token from a client with quarantine:write>'
curl -sS -X PATCH -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"ids":["qf-lab-1"],"action":"release"}' \
http://127.0.0.1:8088/quarantine/entities/quarantined-files/v1

quarantine:write → 200. A token with only quarantine:read → 403. Missing or revoked token → 401.

OAuth2 mint/revoke: OAuth2. Accessible scopes: API clients.