CSPM scan schedule
CSPM scan schedule is the CSPM Registration collection for this CID —
GetCspmScanSchedule (SOURCE GetCSPMScanSchedule, PEP 8
get_scan_schedule) and UpdateCspmScanSchedule (SOURCE
UpdateCSPMScanSchedule, PEP 8 update_scan_schedule). The paths
are GET /settings/scan-schedule/v1 and
POST /settings/scan-schedule/v1 (same path, method POST; distinct
from GET scan schedule, Cloud policies, Prevention policies). Image assessment policies / remaining cloud and other
cloud/container collections are not implemented (not yet). This is
not GetCSPMPolicySettings (/settings/entities/policy/v1),
not GetCSPMPolicy (/settings/entities/policy-details/v1),
not GetCSPMPoliciesDetails (/settings/entities/policy-details/v2),
not Prevention policies (/policy/…), not Cloud IOM
(/detects/entities/iom/…), not Cloud IOA
(/detects/entities/ioa/…), and not GetIOAEvents
(/ioa/entities/events/v1). CSPM policies is a separate
collection: CSPM policies. Prevention policies is a
separate collection: Prevention policies.
Cloud IOM is a separate collection: CSPM IOM. Cloud
IOA is a separate collection: CSPM IOA. Cloud IOA
events is a separate collection:
CSPM IOA events. 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 Falcon Cloud or Horizon.
RPC field notes:
CspmRegistrationService.
REST schemas: API reference. GetCspmScanSchedule uses query
params, not FQL. Filter this slice is optional repeated
cloud-platform. Extra unused query keys including parameters are
ignored. Clone success is JSON MSA 200 CspmScanSchedule. Fields
are cloud_platform, last_scan_completed_at, next_scan_timestamp,
scan_interval, scan_schedule. There is no cid on the wire.
POST update (/settings/scan-schedule/v1) uses JSON body
{cloud_platform, scan_schedule}. Required cloud_platform,
scan_schedule. Extra unused keys including next_scan_timestamp,
scan_interval, resources, and parameters are ignored. The clone
does not persist interval or next timestamp from this POST. Clone POST
success is JSON MSA 200 CspmScanSchedule. POST is distinct from
GET scan schedule (same path, method GET), Cloud policies
(/settings/entities/policy/v1), and Prevention policies (/policy/…).
Unknown cloud_platform (not aws/azure/gcp) → 400. Missing
cloud_platform or scan_schedule → 400. Allowed platform with no
row → 404.
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: Bearerwithcspm-registration:read(GET list) orcspm-registration:write(POST update)
A session cookie bypasses OAuth scopes. Seed client cs-local-hosts
(hosts:read only) cannot list scan schedules or update scan
schedules (403).
GetCspmScanSchedule stays cspm-registration:read (not write).
UpdateCspmScanSchedule needs cspm-registration:write.
cspm-registration:read can list scan schedules and cannot POST
(403). Unit tests use a client named cs-local-cspm with
cspm-registration:read; that client can list scan schedules
(200) and cannot POST (403). Unit tests use
cs-local-cspmw with cspm-registration:write; that client can
POST (200). Neither is in the production seed. There is no seeded
production client with cspm-registration:read or
cspm-registration:write — use the console cookie, or a client you
created with that scope. Missing or revoked token → 401.
HTTP paths
| Method | Path | Use |
|---|---|---|
GET | /settings/scan-schedule/v1 | List CSPM scan schedules. RPC GetCspmScanSchedule (SOURCE GetCSPMScanSchedule). PEP 8 get_scan_schedule. Query: optional cloud-platform (repeated). Success 200 MSA CspmScanSchedule. Extra unused query keys including parameters ignored. Distinct from POST update same path, GetCSPMPolicySettings /settings/entities/policy/v1, GetCSPMPolicy /settings/entities/policy-details/v1, GetCSPMPoliciesDetails /settings/entities/policy-details/v2, Prevention policies /policy/…, Cloud IOM /detects/entities/iom/…, and Cloud IOA /detects/entities/ioa/…. |
POST | /settings/scan-schedule/v1 | Update CSPM scan schedule. RPC UpdateCspmScanSchedule (SOURCE UpdateCSPMScanSchedule). PEP 8 update_scan_schedule. Body JSON {cloud_platform, scan_schedule}. Required cloud_platform, scan_schedule. Success 200 MSA CspmScanSchedule. Extra unused keys ignored. Does not persist interval or next timestamp. Distinct from GET scan schedule same path, Cloud policies /settings/entities/policy/v1, Prevention policies /policy/…. cspm-registration:write. |
Empty cloud-platform returns every schedule in this CID ordered by
cloud_platform ASC. Unknown-but-valid platforms (allowed aws /
azure / gcp with no stored row) are omitted (empty 200 if none
match). If any cloud-platform value is set and is not exactly aws,
azure, or gcp → 400 unknown cloud-platform. Extra unused
query keys including parameters are ignored. Repeated
cloud-platform values are accepted; results stay ordered by
cloud_platform ASC.
JSON is cloud_platform, last_scan_completed_at,
next_scan_timestamp, scan_interval, scan_schedule. POST body is
JSON {cloud_platform, scan_schedule}. Extra unused keys including
next_scan_timestamp and scan_interval are ignored. The clone does
not persist interval or next timestamp from this POST. GET
cloud-platform=aws after POST matches that scan_schedule.
This is not GetCSPMPolicySettings, GetCSPMPolicy,
GetCSPMPoliciesDetails, Prevention policies, Cloud IOM, Cloud IOA, or
the HelloService template. Image assessment policies / remaining cloud and other cloud collections are not
implemented (not yet). Prevention policies uses /policy/…:
Prevention policies. Cloud IOM uses
/detects/entities/iom/…: CSPM IOM. Cloud IOA uses
/detects/entities/ioa/…: CSPM IOA. CSPM policies uses
/settings/entities/policy-details/… and
/settings/entities/policy/v1: CSPM policies.
Seed schedules
cloud_platform | last_scan_completed_at | next_scan_timestamp | scan_interval | scan_schedule |
|---|---|---|---|---|
aws | 2026-09-16T08:00:00Z | 2026-09-18T08:00:00Z | 24h | daily |
azure | 2026-09-15T12:00:00Z | 2026-09-22T12:00:00Z | 7d | weekly |
gcp | 2026-09-17T00:00:00Z | 2026-09-18T00:00:00Z | 24h | daily |
Empty filters return all three (order cloud_platform ASC: aws,
azure, gcp). cloud-platform=aws returns aws. Repeated
cloud-platform=aws&cloud-platform=gcp returns aws then gcp.
POST cloud_platform=aws / scan_schedule=weekly updates aws to
weekly. Seed stored schedule for aws is daily until POST.
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
List scan schedules (cookie)
Empty filters return at least the three seed platforms, including
aws, azure, and gcp:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
cloud-platform=aws returns aws:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/settings/scan-schedule/v1?cloud-platform=aws'
Repeated cloud-platform=aws&cloud-platform=gcp returns aws then
gcp:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/settings/scan-schedule/v1?cloud-platform=aws&cloud-platform=gcp'
Invalid cloud-platform 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/settings/scan-schedule/v1?cloud-platform=foo'
Extra unused query keys including parameters are ignored:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/settings/scan-schedule/v1?parameters=ignored'
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/settings/scan-schedule/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/settings/scan-schedule/v1'
Image assessment policies / remaining cloud
and other cloud collections are not implemented (not yet). Prevention
policies is a separate collection:
Prevention policies. Cloud IOM is a separate
collection: CSPM IOM. Cloud IOA is a separate
collection: CSPM IOA. CSPM policies is a separate
collection: CSPM policies. This is not the
HelloService template (GET /api/hello).
Update scan schedule (cookie)
POST cloud_platform=aws / scan_schedule=weekly on
/settings/scan-schedule/v1 returns that schedule with
scan_schedule weekly. Success is 200 MSA CspmScanSchedule. This
is not GET scan schedule (same path, method GET), not Cloud
policies (/settings/entities/policy/v1), and not Prevention
policies (/policy/…). Required cloud_platform, scan_schedule.
Extra unused keys including next_scan_timestamp, scan_interval,
resources, and parameters are ignored. The clone does not persist
interval or next timestamp from this POST. scan_interval and
next_scan_timestamp stay unchanged. GET cloud-platform=aws after
POST matches that scan_schedule:
curl -sS -X POST -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws","scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
Missing cloud_platform is 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-X POST -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
Missing scan_schedule is 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-X POST -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
Invalid cloud_platform is 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-X POST -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"foo","scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
Allowed platform with no stored row is 404. Extra unused keys
including next_scan_timestamp and scan_interval are ignored
(interval and next timestamp are not persisted):
curl -sS -X POST -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws","scan_schedule":"weekly","next_scan_timestamp":"ignored","scan_interval":"ignored","resources":[],"parameters":"ignored"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
cs-local-hosts (hosts:read only) is 403 on POST:
TOKEN='<access_token from cs-local-hosts>'
curl -sS -o /dev/null -w '%{http_code}\n' \
-X POST -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws","scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
cs-local-cspm (cspm-registration:read) is 403 on POST:
TOKEN='<access_token from cs-local-cspm>'
curl -sS -o /dev/null -w '%{http_code}\n' \
-X POST -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws","scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
No cookie and no Bearer is 401 on POST:
curl -sS -o /dev/null -w '%{http_code}\n' \
-X POST -H 'Host: crowdstrike-api.localhost' \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws","scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
Image assessment policies / remaining cloud
and other cloud collections are not implemented (not yet). Prevention
policies is a separate collection:
Prevention policies. Cloud IOM is a separate
collection: CSPM IOM. Cloud IOA is a separate
collection: CSPM IOA. CSPM policies is a separate
collection: CSPM policies. This is not the
HelloService template (GET /api/hello).
List (Bearer)
TOKEN='<access_token from a client with cspm-registration:read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
cspm-registration:read → 200 (including unit-test client
cs-local-cspm). A token without that scope (including hosts:read
only, e.g. cs-local-hosts) → 403. Missing or revoked token →
401. GetCspmScanSchedule stays cspm-registration:read. PEP 8
get_scan_schedule. There is no seeded production client with
cspm-registration:read — use the console cookie, or a client you
created with that scope.
Update (Bearer)
TOKEN='<access_token from a client with cspm-registration:write>'
curl -sS -X POST -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"cloud_platform":"aws","scan_schedule":"weekly"}' \
'http://127.0.0.1:8088/settings/scan-schedule/v1'
cspm-registration:write → 200 on POST (including unit-test client
cs-local-cspmw). A token without that scope (including hosts:read
only, e.g. cs-local-hosts, or cspm-registration:read such as
cs-local-cspm) → 403. Missing or revoked token → 401. There is
no product-seeded write client with cspm-registration:write — use the
console cookie, or a client you created with that scope.
UpdateCspmScanSchedule stays cspm-registration:write. SOURCE
UpdateCSPMScanSchedule. PEP 8 update_scan_schedule. Distinct
from GET scan schedule /settings/scan-schedule/v1, Cloud policies
/settings/entities/policy/v1, and Prevention policies /policy/….
Extra unused keys ignored. Required body cloud_platform,
scan_schedule. The clone does not persist interval or next timestamp
from this POST. Image assessment policies / remaining cloud and other cloud collections are
not implemented (not yet).
OAuth2 mint/revoke: OAuth2. Accessible scopes: API clients.