K8s API key
Kubernetes integration API key is the Kubernetes Protection collection
for this CID — RegenerateAPIKey (PEP 8 regenerate) and
GetIntegrationAPIKey. The path is
GET /kubernetes-protection/entities/integration/api-key/v1 (and
POST on the same path).
Remaining Kubernetes Protection mutations /
Image assessment policies / remaining cloud are not implemented (not yet). ReadClusterCombinedV2
is not implemented. This is not Registry credentials
GetCredentials
(/container-security/entities/image-registry-credentials/v1):
Registry credentials. This is not
Installation tokens (/installation-tokens/…):
Installation tokens. This is not
Kubernetes Helm values GetHelmValuesYaml
(/kubernetes-protection/entities/integration/agent/v1):
K8s helm. This is not Kubernetes vulnerable
image counts ReadVulnerableContainerImageCount
(/container-security/aggregates/containers/count-vulnerable-images/v1):
K8s vuln images. This is not
the HelloService template sample (GET /api/hello).
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 integration API keys have no query params and do not use FQL (unlike Kubernetes vulnerable image counts). Extra unused query keys are ignored.
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: Bearerwithkubernetes-protection:write
GET and POST both require that write scope. A session cookie bypasses
OAuth scopes. Seed client cs-local-hosts (hosts:read only) cannot
get or regenerate the key (403). kubernetes-protection:read
cannot get or regenerate the key (403). Unit tests use a client
named cs-local-cimg with falcon-container-image:read; that client
cannot get or regenerate the key (403). Unit tests use a client
named cs-local-k8s with kubernetes-protection:read; that client
cannot get or regenerate the key (403). Unit tests use a client
named cs-local-k8sw with kubernetes-protection:write; that client
can get and regenerate the key. It is not in the production
seed. Use the console cookie, or a client you created with that scope.
Missing or revoked token → 401.
HTTP paths
| Method | Path | Use |
|---|---|---|
GET | /kubernetes-protection/entities/integration/api-key/v1 | Get the current key. No query params. Does not rotate. |
POST | /kubernetes-protection/entities/integration/api-key/v1 | Regenerate. Empty body. Success 200. |
JSON is snake_case MSA: api_key. Clone success is 200 (not SOURCE
207). POST persists lab-k8s-api-key-2 and returns that value. A
second POST stays lab-k8s-api-key-2.
This is not Registry credentials, Installation tokens, Kubernetes
Helm values, Kubernetes vulnerable image counts, or the HelloService
template. Registry credentials uses
/container-security/entities/image-registry-credentials/v1:
Registry credentials. Installation tokens
uses /installation-tokens/…:
Installation tokens. Kubernetes Helm values
uses /kubernetes-protection/entities/integration/agent/v1:
K8s helm. Kubernetes vulnerable image counts uses
/container-security/aggregates/containers/count-vulnerable-images/v1:
K8s vuln images. Remaining
Kubernetes Protection mutations / Image assessment policies / remaining cloud are not
implemented (not yet).
Seed API key
api_key |
|---|
lab-k8s-api-key-1 |
The list returns one resource with that key. GET does not rotate.
POST returns lab-k8s-api-key-2. There is no filter.
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
Get API key (cookie)
The get returns the seed key lab-k8s-api-key-1:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/kubernetes-protection/entities/integration/api-key/v1'
Regenerate API key (cookie)
POST returns lab-k8s-api-key-2. Empty body. Success is 200. A
later GET of the same path returns lab-k8s-api-key-2. A second POST
stays lab-k8s-api-key-2:
curl -sS -X POST -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/kubernetes-protection/entities/integration/api-key/v1'
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/integration/api-key/v1'
cs-local-hosts (hosts:read only) is 403:
TOKEN='<access_token from cs-local-hosts>'
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/kubernetes-protection/entities/integration/api-key/v1'
cs-local-k8s (kubernetes-protection:read) is 403:
TOKEN='<access_token from cs-local-k8s>'
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/kubernetes-protection/entities/integration/api-key/v1'
Remaining Kubernetes Protection mutations /
Image assessment policies / remaining cloud are not implemented (not yet). Registry credentials
is a separate collection:
Registry credentials. Installation tokens
is a separate collection:
Installation tokens. Kubernetes Helm values
is a separate collection: K8s helm. Kubernetes
vulnerable image counts is a separate collection:
K8s vuln images. This is not
the HelloService template (GET /api/hello).
Get / regenerate (Bearer)
TOKEN='<access_token from a client with kubernetes-protection:write>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/kubernetes-protection/entities/integration/api-key/v1'
TOKEN='<access_token from a client with kubernetes-protection:write>'
curl -sS -X POST -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/kubernetes-protection/entities/integration/api-key/v1'
kubernetes-protection:write → 200 (including unit-test client
cs-local-k8sw). A token without that scope (including hosts:read
only, e.g. cs-local-hosts, kubernetes-protection:read, e.g.
cs-local-k8s, or falcon-container-image:read, e.g. cs-local-cimg)
→ 403. Missing or revoked token → 401. There is no seeded
production client with kubernetes-protection:write — use the console
cookie, or a client you created with that scope.
OAuth2 mint/revoke: OAuth2. Accessible scopes: API clients.