Skip to main content

Kubernetes

Kubernetes Protection is the cluster-list collection for this CID — GetClusters. The path is GET /kubernetes-protection/entities/kubernetes/clusters/v1. Remaining Kubernetes Protection ops (account mutations, IOMs, aggregates) and other cloud/container collections are not implemented (not yet). This is not Event streams (/sensors/entities/datafeed) and not Hosts (/devices/…). Kubernetes cloud locations is a separate collection: K8s locations. K8s helm is a separate collection: K8s helm. K8s pods is a separate collection: K8s pods. K8s nodes is a separate collection: K8s nodes. K8s containers is a separate collection: K8s containers. K8s deployments is a separate collection: K8s deployments. Combined Kubernetes clusters is a separate collection: K8s combined clusters.

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

RPC field notes: KubernetesProtectionService. REST schemas: API reference. Kubernetes Protection uses query params, not 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 kubernetes-protection:read

A session cookie bypasses OAuth scopes. Seed client cs-local-hosts (hosts:read only) cannot list clusters (403). There is no seeded client with kubernetes-protection:read — use the console cookie, or a client you created with that scope. Missing or revoked token → 401.

HTTP paths​

MethodPathUse
GET/kubernetes-protection/entities/kubernetes/clusters/v1List clusters. Query: cluster_names, status, account_ids, locations, cluster_service (aks | eks), limit, offset.

Filters are exact match. Empty query params return every cluster in this CID. cluster_service other than aks or eks → 400. status other than Not Installed, Running, or Stopped → 400. limit and offset must be ≥ 0 else 400. Omitted limit defaults to 100 (capped at 500).

JSON is SOURCE snake_case: cluster_id, cluster_name, cluster_service, status, location, account_id, cid.

This is not Event streams or Hosts. Event streams uses /sensors/entities/datafeed/…: Event streams. Hosts uses /devices/…: Hosts. Kubernetes cloud locations uses /kubernetes-protection/entities/cloud-locations/v1: K8s locations. Remaining Kubernetes Protection ops and other cloud collections are not implemented (not yet).

Seed clusters​

cluster_idcluster_namecluster_servicestatuslocationaccount_id
k8s-lab-1lab-eks-1eksRunningus-east-1111111111111
k8s-lab-2lab-aks-1aksRunningeastussub-lab-1

cid is cid-local-1. Empty filters return both. cluster_service=eks returns k8s-lab-1 (lab-eks-1). status=Running returns both.

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 filters return at least the two seed ids, including k8s-lab-1:

curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/kubernetes-protection/entities/kubernetes/clusters/v1'

cluster_service=eks returns lab-eks-1:

curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/kubernetes-protection/entities/kubernetes/clusters/v1?cluster_service=eks'

Bad cluster_service 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/kubernetes-protection/entities/kubernetes/clusters/v1?cluster_service=gke'

Unknown status 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/kubernetes-protection/entities/kubernetes/clusters/v1?status=running'

No cookie and no Bearer is 401:

curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' \
'http://127.0.0.1:8088/kubernetes-protection/entities/kubernetes/clusters/v1'

Remaining Kubernetes Protection ops (account mutations, IOMs, aggregates) and other cloud collections are not implemented (not yet). Event streams is a separate collection: Event streams. Hosts is a separate collection: Hosts. Kubernetes cloud locations is a separate collection: K8s locations. K8s helm is a separate collection: K8s helm. K8s pods is a separate collection: K8s pods. K8s nodes is a separate collection: K8s nodes. K8s containers is a separate collection: K8s containers. K8s deployments is a separate collection: K8s deployments. Combined Kubernetes clusters is a separate collection: K8s combined clusters.

List (Bearer)​

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

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

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