1
| Method | Path | Summary |
|---|---|---|
| GET | / | admin console SPA + embedded static assets (§8; more-specific routes win) |
.well-known 4
| Method | Path | Summary |
|---|---|---|
| GET | /.well-known/api-capabilities | §53 capability matrix discovery (free-tier; platform.capability_discovery) |
| GET | /.well-known/federation | federation topology (§40 free-tier) |
| GET | /.well-known/openapi.json | OpenAPI contract pointer (§40 free-tier) |
| GET | /.well-known/security.txt | RFC 9116 security contact (§40 free-tier) |
_audit 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/_audit/activity | Requires entitlement control_plane.shell |
| GET | /v1/_audit/verify | Requires entitlement control_plane.shell |
admin 4
| Method | Path | Summary |
|---|---|---|
| POST | /admin/break-glass | §98 IdP-independent break-glass — never entitlement-gated |
| POST | /admin/break-glass/setup | Requires entitlement control_plane.shell |
| GET | /v1/admin/log-level | Requires entitlement control_plane.shell |
| PUT | /v1/admin/log-level | Requires entitlement control_plane.shell |
ai 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/ai/models | List registered AI models (§13) |
| POST | /v1/ai/models | Register an AI model card (§13) |
| POST | /v1/ai/models/{id}/promote | Advance a model's governance lifecycle (§13) |
| POST | /v1/ai/models/{id}/retire | Retire an AI model (§13) |
aiops 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/aiops/anomalies | Requires entitlement control_plane.aiops |
| GET | /v1/aiops/health | Requires entitlement control_plane.aiops |
| POST | /v1/aiops/scan | Requires entitlement control_plane.aiops |
analytics 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/analytics/datasets | Requires entitlement control_plane.shell |
| POST | /v1/analytics/query | Requires entitlement control_plane.shell |
asyncapi.yaml 1
| Method | Path | Summary |
|---|---|---|
| GET | /asyncapi.yaml | AsyncAPI 3.0 event contract (§7) |
audit 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/audit/auditor-grants | Requires entitlement control_plane.shell |
| POST | /v1/audit/auditor-grants | Requires entitlement control_plane.shell |
| DELETE | /v1/audit/auditor-grants/{subject} | Requires entitlement control_plane.shell |
| GET | /v1/audit/evidence-locker | Requires entitlement platform.customer_auditor_role |
| GET | /v1/audit/evidence-locker/export | Requires entitlement platform.customer_auditor_role |
auth 12
| Method | Path | Summary |
|---|---|---|
| GET | /auth/callback | pre-auth OIDC callback (bootstrap exemption §36) |
| POST | /auth/local/login | local-account login (pre-auth; admin-enabled) |
| GET | /auth/login | Begin OIDC SSO (redirects to IdP) |
| POST | /auth/logout | session teardown |
| POST | /auth/saml/acs | SAML assertion consumer service (pre-auth) |
| GET | /auth/saml/metadata | SP SAML metadata for IdP registration (pre-auth) |
| GET | /auth/saml/{id}/login | start SAML SSO for a provider (pre-auth) |
| GET | /auth/sso | email-domain home-realm discovery → per-tenant IdP (pre-auth) |
| POST | /auth/webauthn/login/begin | MFA verification during auth (§3/§18) |
| POST | /auth/webauthn/login/finish | MFA verification during auth (§3/§18) |
| POST | /auth/webauthn/register/begin | MFA enrolment during auth (§3/§18) |
| POST | /auth/webauthn/register/finish | MFA enrolment during auth (§3/§18) |
collab 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/collab/{doc} | Requires entitlement control_plane.shell |
| POST | /v1/collab/{doc}/op | Requires entitlement control_plane.shell |
| GET | /v1/collab/{doc}/stream | Requires entitlement control_plane.shell |
collective 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/collective/iocs | Requires entitlement control_plane.collective_defense |
| POST | /v1/collective/iocs | Requires entitlement control_plane.collective_defense |
| POST | /v1/collective/optin | Requires entitlement control_plane.collective_defense |
| GET | /v1/collective/status | Requires entitlement control_plane.collective_defense |
config-drift 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/config-drift/baselines | Requires entitlement control_plane.config_drift |
| POST | /v1/config-drift/baselines | Requires entitlement control_plane.config_drift |
| POST | /v1/config-drift/check | Requires entitlement control_plane.config_drift |
| GET | /v1/config-drift/drifts | Requires entitlement control_plane.config_drift |
contracts 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/contracts | Requires entitlement platform.contract_registry |
| GET | /v1/contracts/{name} | Requires entitlement platform.contract_registry |
correlation 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/correlation/incidents | Requires entitlement control_plane.correlation |
| GET | /v1/correlation/live | Requires entitlement control_plane.correlation |
| POST | /v1/correlation/run | Requires entitlement control_plane.correlation |
crypto 1
| Method | Path | Summary |
|---|---|---|
| GET | /v1/crypto/status | crypto manifest + FIPS mode + PQC readiness (§19 free-tier) |
ctem 9
| Method | Path | Summary |
|---|---|---|
| POST | /v1/ctem/assess | Requires entitlement control_plane.exposure_mgmt |
| GET | /v1/ctem/assessments | List CTEM assessments (cursor-paginated) |
| POST | /v1/ctem/attack-path | Requires entitlement control_plane.attack_path |
| POST | /v1/ctem/cve-feed | Requires entitlement control_plane.exposure_mgmt |
| POST | /v1/ctem/cve-feed/fetch | Pull live CVEs from NVD/OSV into the tenant feed |
| GET | /v1/ctem/exposures | Requires entitlement control_plane.exposure_mgmt |
| GET | /v1/ctem/scope | Requires entitlement control_plane.exposure_mgmt |
| POST | /v1/ctem/validate | Requires entitlement control_plane.validation_bas |
| GET | /v1/ctem/vectors | Requires entitlement control_plane.exposure_mgmt |
data-ops 3
| Method | Path | Summary |
|---|---|---|
| POST | /v1/data-ops/export-snapshot | Requires entitlement platform.self_service_data_ops |
| GET | /v1/data-ops/jobs | Requires entitlement platform.self_service_data_ops |
| POST | /v1/data-ops/purge | Requires entitlement platform.self_service_data_ops |
deception 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/deception/honeytokens | Requires entitlement control_plane.deception |
| POST | /v1/deception/honeytokens | Requires entitlement control_plane.deception |
| DELETE | /v1/deception/honeytokens/{id} | Requires entitlement control_plane.deception |
| POST | /v1/deception/trip | Requires entitlement control_plane.deception |
| GET | /v1/deception/trips | Requires entitlement control_plane.deception |
detect 8
| Method | Path | Summary |
|---|---|---|
| GET | /v1/detect/findings | Requires entitlement control_plane.detection_hub |
| POST | /v1/detect/findings/{id}/escalate | Requires entitlement control_plane.detection_hub |
| GET | /v1/detect/rules | Requires entitlement control_plane.detection_hub |
| POST | /v1/detect/rules | Requires entitlement control_plane.detection_hub |
| POST | /v1/detect/rules/import-sigma | Requires entitlement control_plane.detection_hub |
| POST | /v1/detect/rules/install-starters | Requires entitlement control_plane.detection_hub |
| POST | /v1/detect/rules/test | Requires entitlement control_plane.detection_hub |
| DELETE | /v1/detect/rules/{id} | Requires entitlement control_plane.detection_hub |
detections 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/detections | List detections (cursor-paginated, det_id keyset) |
| POST | /v1/detections | Upsert a detection |
| GET | /v1/detections/coverage | Requires entitlement control_plane.attack_coverage_map |
detonation 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/detonation/jobs | Requires entitlement control_plane.detonation |
| GET | /v1/detonation/provider | Requires entitlement control_plane.detonation |
| POST | /v1/detonation/submit | Requires entitlement control_plane.detonation |
dlp 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/dlp/egress-events | Requires entitlement control_plane.dlp |
| GET | /v1/dlp/rules | List DLP detectors (built-in + tenant) (§104) |
| POST | /v1/dlp/rules | Create/update a tenant DLP detector (§104) |
| DELETE | /v1/dlp/rules/{id} | Delete a tenant DLP detector (§104) |
| POST | /v1/dlp/scan | Scan content for a DLP verdict allow/redact/block (§104) |
drp 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/drp/assets | Requires entitlement control_plane.drp |
| POST | /v1/drp/assets | Requires entitlement control_plane.drp |
| GET | /v1/drp/findings | Requires entitlement control_plane.drp |
| POST | /v1/drp/ingest | Requires entitlement control_plane.drp |
| POST | /v1/drp/simulate | Requires entitlement control_plane.drp |
dualcontrol 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/dualcontrol | Requires entitlement control_plane.shell |
| POST | /v1/dualcontrol/{id}/approve | Requires entitlement control_plane.shell |
| POST | /v1/dualcontrol/{id}/reject | Requires entitlement control_plane.shell |
estate 29
| Method | Path | Summary |
|---|---|---|
| POST | /v1/estate/agent/poll | agent check-in: pull queued commands (agent-token authed, §89) |
| POST | /v1/estate/agent/result | agent check-in: post command result (agent-token authed, §89) |
| GET | /v1/estate/agents | Requires entitlement control_plane.estate_inventory |
| POST | /v1/estate/agents/enroll | Requires entitlement control_plane.estate_inventory |
| GET | /v1/estate/breakglass | Requires entitlement control_plane.session_broker |
| POST | /v1/estate/breakglass/request | Requires entitlement control_plane.session_broker |
| POST | /v1/estate/breakglass/{id}/approve | Requires entitlement control_plane.session_broker |
| GET | /v1/estate/capabilities | Requires entitlement control_plane.estate_inventory |
| GET | /v1/estate/config-applied | Requires entitlement control_plane.estate_inventory |
| GET | /v1/estate/credential-providers | Requires entitlement control_plane.estate_pam |
| GET | /v1/estate/credentials | Requires entitlement control_plane.estate_pam |
| POST | /v1/estate/credentials | Requires entitlement control_plane.estate_pam |
| DELETE | /v1/estate/credentials/{id} | Requires entitlement control_plane.estate_pam |
| POST | /v1/estate/fanout | Requires entitlement control_plane.estate_response |
| GET | /v1/estate/host-keys | Requires entitlement control_plane.estate_inventory |
| POST | /v1/estate/host-keys/reset | Requires entitlement control_plane.estate_inventory |
| POST | /v1/estate/killswitch | Requires entitlement control_plane.estate_response |
| POST | /v1/estate/killswitch/reset | Requires entitlement control_plane.estate_response |
| POST | /v1/estate/packs/apply | Requires entitlement control_plane.estate_policy |
| POST | /v1/estate/packs/plan | Requires entitlement control_plane.estate_policy |
| GET | /v1/estate/pam-connectors | Requires entitlement control_plane.estate_pam |
| POST | /v1/estate/pam-connectors | Requires entitlement control_plane.estate_pam |
| DELETE | /v1/estate/pam-connectors/{id} | Requires entitlement control_plane.estate_pam |
| POST | /v1/estate/sessions | Requires entitlement control_plane.session_broker |
| POST | /v1/estate/sessions/{id}/exec | Requires entitlement control_plane.session_broker |
| GET | /v1/estate/sessions/{id}/recording | Requires entitlement control_plane.session_broker |
| GET | /v1/estate/targets | List estate targets (cursor-paginated) |
| POST | /v1/estate/targets | Requires entitlement control_plane.estate_inventory |
| GET | /v1/estate/topology | Requires entitlement control_plane.estate_inventory |
events 2
| Method | Path | Summary |
|---|---|---|
| POST | /v1/events/emit | Requires entitlement control_plane.shell |
| GET | /v1/events/stream | Requires entitlement control_plane.shell |
federation 8
| Method | Path | Summary |
|---|---|---|
| GET | /v1/federation/children | List federated child instances (§37/§49) |
| POST | /v1/federation/children | Register a child instance under this parent (§37/§49) |
| DELETE | /v1/federation/children/{id} | Deregister a child instance (§37/§49) |
| GET | /v1/federation/children/{id} | Requires entitlement suite.federation_core |
| POST | /v1/federation/children/{id}/heartbeat | Requires entitlement suite.federation_core |
| GET | /v1/federation/health | Aggregate federation health across children (§37/§49) |
| GET | /v1/federation/openapi | Requires entitlement platform.federation_openapi |
| GET | /v1/federation/posture | Requires entitlement suite.federation_core |
fleets 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/fleets | Requires entitlement control_plane.fleet_mgmt |
| POST | /v1/fleets | Requires entitlement control_plane.fleet_mgmt |
| DELETE | /v1/fleets/{id} | Requires entitlement control_plane.fleet_mgmt |
| GET | /v1/fleets/{id} | Requires entitlement control_plane.fleet_mgmt |
| POST | /v1/fleets/{id}/members | Requires entitlement control_plane.fleet_mgmt |
geo-fence 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/geo-fence | Requires entitlement control_plane.shell |
| PUT | /v1/geo-fence | Requires entitlement control_plane.shell |
healthz 2
| Method | Path | Summary |
|---|---|---|
| GET | /healthz | Liveness probe (free-tier) |
| GET | /healthz/deep | deep dependency health (per-component; free-tier) |
iam 33
| Method | Path | Summary |
|---|---|---|
| GET | /v1/iam/auth-settings | Requires entitlement control_plane.shell |
| PUT | /v1/iam/auth-settings | Requires entitlement control_plane.shell |
| GET | /v1/iam/external-backends | Requires entitlement control_plane.shell |
| PUT | /v1/iam/external-backends | Requires entitlement control_plane.shell |
| GET | /v1/iam/idps | Requires entitlement control_plane.shell |
| POST | /v1/iam/idps | Requires entitlement control_plane.shell |
| DELETE | /v1/iam/idps/{id} | Requires entitlement control_plane.shell |
| GET | /v1/iam/ip-allowlist | Requires entitlement control_plane.shell |
| PUT | /v1/iam/ip-allowlist | Requires entitlement control_plane.shell |
| GET | /v1/iam/local-users | Requires entitlement control_plane.shell |
| POST | /v1/iam/local-users | Requires entitlement control_plane.shell |
| DELETE | /v1/iam/local-users/{username} | Requires entitlement control_plane.shell |
| POST | /v1/iam/local-users/{username}/password | Requires entitlement control_plane.shell |
| GET | /v1/iam/rbac/effective | Requires entitlement control_plane.shell |
| GET | /v1/iam/rbac/grants | Requires entitlement control_plane.shell |
| DELETE | /v1/iam/rbac/roles/{role} | Requires entitlement control_plane.shell |
| PUT | /v1/iam/rbac/roles/{role} | Requires entitlement control_plane.shell |
| GET | /v1/iam/rbac/settings | Requires entitlement control_plane.shell |
| PUT | /v1/iam/rbac/settings | Requires entitlement control_plane.shell |
| GET | /v1/iam/role-mappings | Requires entitlement control_plane.shell |
| PUT | /v1/iam/role-mappings | Requires entitlement control_plane.shell |
| GET | /v1/iam/saml-idps | Requires entitlement control_plane.shell |
| POST | /v1/iam/saml-idps | Requires entitlement control_plane.shell |
| DELETE | /v1/iam/saml-idps/{id} | Requires entitlement control_plane.shell |
| GET | /v1/iam/service-tokens | Requires entitlement control_plane.shell |
| POST | /v1/iam/service-tokens | Requires entitlement control_plane.shell |
| DELETE | /v1/iam/service-tokens/{id} | Requires entitlement control_plane.shell |
| POST | /v1/iam/service-tokens/{id}/rotate | Requires entitlement control_plane.shell |
| GET | /v1/iam/sessions | Requires entitlement control_plane.shell |
| POST | /v1/iam/sessions/revoke-others | Requires entitlement control_plane.shell |
| DELETE | /v1/iam/sessions/{id} | Requires entitlement control_plane.shell |
| POST | /v1/iam/totp/enroll | Requires entitlement control_plane.shell |
| POST | /v1/iam/totp/verify | Requires entitlement control_plane.shell |
iga 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/iga/campaigns | Requires entitlement control_plane.access_certification |
| POST | /v1/iga/certify | Requires entitlement control_plane.access_certification |
| POST | /v1/iga/joiner | Requires entitlement control_plane.iga |
| POST | /v1/iga/leaver | Requires entitlement control_plane.iga |
| POST | /v1/iga/sod/check | Requires entitlement control_plane.sod |
integrations 33
| Method | Path | Summary |
|---|---|---|
| GET | /v1/integrations/approvals | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/approvals/{id}/approve | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/approvals/{id}/reject | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/blueprints | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/blueprints/import | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/blueprints/import-url | Requires entitlement control_plane.device_blueprints |
| DELETE | /v1/integrations/blueprints/{id} | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/blueprints/{id} | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/blueprints/{id}/diff | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/blueprints/{id}/validate-sample | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/call-quota | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/call-quota | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/devices | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/devices | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/devices/export | Requires entitlement control_plane.device_blueprints |
| DELETE | /v1/integrations/devices/{id} | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/devices/{id} | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/devices/{id}/call | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/devices/{id}/calls | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/devices/{id}/credentials | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/devices/{id}/endpoint-version | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/devices/{id}/health | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/devices/{id}/limits | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/devices/{id}/tags | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/egress-allowlist | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/egress-allowlist | Requires entitlement control_plane.device_blueprints |
| DELETE | /v1/integrations/egress-allowlist/{id} | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/fleet/call | Requires entitlement control_plane.device_blueprints |
| GET | /v1/integrations/schedules | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/schedules | Requires entitlement control_plane.device_blueprints |
| DELETE | /v1/integrations/schedules/{id} | Requires entitlement control_plane.device_blueprints |
| PUT | /v1/integrations/schedules/{id} | Requires entitlement control_plane.device_blueprints |
| POST | /v1/integrations/schedules/{id}/run-now | Requires entitlement control_plane.device_blueprints |
intel 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/intel/collections/{id}/objects | Requires entitlement control_plane.threat_intel |
| GET | /v1/intel/indicators | Requires entitlement control_plane.threat_intel |
| POST | /v1/intel/indicators | Requires entitlement control_plane.threat_intel |
| POST | /v1/intel/indicators/{id}/suppress | Requires entitlement control_plane.threat_intel |
| POST | /v1/intel/indicators/{id}/unsuppress | Requires entitlement control_plane.threat_intel |
itdr 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/itdr/detections | Requires entitlement control_plane.itdr |
| POST | /v1/itdr/scan | Requires entitlement control_plane.itdr |
| GET | /v1/itdr/signals | Requires entitlement control_plane.itdr |
itsm 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/itsm/connectors | Requires entitlement control_plane.shell |
| POST | /v1/itsm/connectors | Requires entitlement control_plane.shell |
| DELETE | /v1/itsm/connectors/{id} | Requires entitlement control_plane.shell |
| POST | /v1/itsm/connectors/{id}/push | Requires entitlement control_plane.shell |
| POST | /v1/itsm/connectors/{id}/test | Requires entitlement control_plane.shell |
lake 2
| Method | Path | Summary |
|---|---|---|
| POST | /v1/lake/ingest | Requires entitlement control_plane.security_data_lake |
| POST | /v1/lake/query | Requires entitlement control_plane.federated_search |
licensing 6
| Method | Path | Summary |
|---|---|---|
| GET | /v1/licensing/airgap | Requires entitlement platform.airgap_licensing |
| GET | /v1/licensing/continuity | §97 continuity/escrow posture (free-tier) |
| POST | /v1/licensing/continuity/activate | Requires entitlement platform.continuity_escrow |
| GET | /v1/licensing/mtls-profile | Requires entitlement platform.mtls_license_profile |
| GET | /v1/licensing/online | Requires entitlement platform.online_licensing |
| GET | /v1/licensing/status | Licensing posture (visible without egress, §36) |
livez 1
| Method | Path | Summary |
|---|---|---|
| GET | /livez | liveness probe (free-tier) |
lockbox 9
| Method | Path | Summary |
|---|---|---|
| GET | /v1/lockbox/byok | Requires entitlement platform.byok_envelope |
| POST | /v1/lockbox/hyok/decrypt | Requires entitlement platform.hyok |
| POST | /v1/lockbox/hyok/encrypt | Requires entitlement platform.hyok |
| POST | /v1/lockbox/hyok/provision | Requires entitlement platform.hyok |
| POST | /v1/lockbox/hyok/revoke | Requires entitlement platform.hyok |
| GET | /v1/lockbox/hyok/status | Requires entitlement platform.hyok |
| GET | /v1/lockbox/requests | Requires entitlement platform.customer_lockbox |
| POST | /v1/lockbox/requests | Requires entitlement platform.customer_lockbox |
| POST | /v1/lockbox/requests/{id}/decision | Requires entitlement platform.customer_lockbox |
logs 12
| Method | Path | Summary |
|---|---|---|
| GET | /v1/logs/collectors | Requires entitlement control_plane.shell |
| POST | /v1/logs/collectors | Requires entitlement control_plane.shell |
| DELETE | /v1/logs/collectors/{id} | Requires entitlement control_plane.shell |
| GET | /v1/logs/export | Tenant-scoped log export (NDJSON, §6) |
| GET | /v1/logs/flows | Requires entitlement control_plane.shell |
| POST | /v1/logs/ingest | Requires entitlement control_plane.shell |
| GET | /v1/logs/investigations | Requires entitlement control_plane.shell |
| POST | /v1/logs/investigations | Requires entitlement control_plane.shell |
| DELETE | /v1/logs/investigations/{id} | Requires entitlement control_plane.shell |
| GET | /v1/logs/search | Requires entitlement control_plane.shell |
| POST | /v1/logs/seed | Requires entitlement control_plane.shell |
| GET | /v1/logs/topology | Requires entitlement control_plane.shell |
marketplace 1
| Method | Path | Summary |
|---|---|---|
| GET | /v1/marketplace/catalog | §39 marketplace catalog (free-tier browse) |
mcp 1
| Method | Path | Summary |
|---|---|---|
| POST | /v1/mcp | Requires entitlement control_plane.shell |
me 1
| Method | Path | Summary |
|---|---|---|
| GET | /v1/me | Current principal (RBAC + entitlement checked) |
metering 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/metering/events | Requires entitlement control_plane.shell |
| POST | /v1/metering/export | Requires entitlement platform.customer_auditor_role |
| GET | /v1/metering/rollup | Requires entitlement control_plane.shell |
metrics 1
| Method | Path | Summary |
|---|---|---|
| GET | /metrics | §6 Prometheus scrape endpoint (protect at the network layer) |
migrate 3
| Method | Path | Summary |
|---|---|---|
| POST | /v1/migrate/import | Requires entitlement control_plane.competitor_migration |
| GET | /v1/migrate/jobs | Requires entitlement control_plane.competitor_migration |
| GET | /v1/migrate/sources | Requires entitlement control_plane.competitor_migration |
modules 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/modules | Requires entitlement platform.module_hot_reload |
| POST | /v1/modules/register | Requires entitlement platform.module_hot_reload |
| POST | /v1/modules/{name}/reload | Requires entitlement platform.module_hot_reload |
msp 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/msp/managed | Requires entitlement control_plane.msp |
| POST | /v1/msp/managed | Requires entitlement control_plane.msp |
| DELETE | /v1/msp/managed/{id} | Requires entitlement control_plane.msp |
| GET | /v1/msp/soc | Requires entitlement control_plane.comanaged_soc |
notifications 6
| Method | Path | Summary |
|---|---|---|
| GET | /v1/notifications/channels | Requires entitlement control_plane.shell |
| POST | /v1/notifications/channels | Requires entitlement control_plane.shell |
| DELETE | /v1/notifications/channels/{id} | Requires entitlement control_plane.shell |
| POST | /v1/notifications/channels/{id}/test | Requires entitlement control_plane.shell |
| GET | /v1/notifications/deliveries | Requires entitlement control_plane.shell |
| POST | /v1/notifications/deliveries/{id}/replay | Requires entitlement control_plane.shell |
observability 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/observability/forward-queue | Requires entitlement control_plane.shell |
| POST | /v1/observability/forward-queue/replay | Requires entitlement control_plane.shell |
| GET | /v1/observability/retention | Requires entitlement control_plane.shell |
| PUT | /v1/observability/retention | Requires entitlement control_plane.shell |
openapi.json 1
| Method | Path | Summary |
|---|---|---|
| GET | /v1/openapi.json | OpenAPI JSON for the in-app explorer (§25) |
openapi.yaml 1
| Method | Path | Summary |
|---|---|---|
| GET | /openapi.yaml | OpenAPI 3.1 contract (§25) |
org 6
| Method | Path | Summary |
|---|---|---|
| GET | /v1/org/children | Requires entitlement control_plane.shell |
| POST | /v1/org/children | Requires entitlement control_plane.shell |
| DELETE | /v1/org/children/{id} | Requires entitlement control_plane.shell |
| POST | /v1/org/invite | Requires entitlement control_plane.shell |
| GET | /v1/org/parent | Requires entitlement control_plane.shell |
| GET | /v1/org/rollup | Requires entitlement control_plane.shell |
ot 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/ot/assets | Requires entitlement control_plane.ot_visibility |
| POST | /v1/ot/assets | Requires entitlement control_plane.ot_visibility |
| GET | /v1/ot/safety-posture | Requires entitlement control_plane.ot_readonly |
| POST | /v1/ot/simulate-seed | Requires entitlement control_plane.ot_readonly |
| GET | /v1/ot/zones | Requires entitlement control_plane.ot_visibility |
policies 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/policies | List policies (cursor-paginated) |
| POST | /v1/policies | Publish a policy (pending second approver — two-person rule, §3) |
| POST | /v1/policies/{id}/approve | Approve/reject a pending policy (distinct approver required) |
policy 8
| Method | Path | Summary |
|---|---|---|
| GET | /v1/policy/firewall | Requires entitlement control_plane.estate_policy |
| POST | /v1/policy/firewall | Requires entitlement control_plane.estate_policy |
| POST | /v1/policy/firewall/import | Requires entitlement control_plane.estate_policy |
| GET | /v1/policy/firewall/live | Requires entitlement control_plane.estate_policy |
| DELETE | /v1/policy/firewall/{id} | Requires entitlement control_plane.estate_policy |
| PATCH | /v1/policy/firewall/{id} | Requires entitlement control_plane.estate_policy |
| POST | /v1/policy/firewall/{id}/duplicate | Requires entitlement control_plane.estate_policy |
| POST | /v1/policy/simulate | Policy simulator — which precedence layer decides (§3) |
policy-twin 4
| Method | Path | Summary |
|---|---|---|
| POST | /v1/policy-twin/simulate | Requires entitlement control_plane.policy_twin |
| GET | /v1/policy-twin/suites | Requires entitlement control_plane.policy_twin |
| POST | /v1/policy-twin/suites | Requires entitlement control_plane.policy_twin |
| POST | /v1/policy-twin/suites/{id}/run | Requires entitlement control_plane.policy_twin |
posture 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/posture/history | Requires entitlement control_plane.posture_score |
| GET | /v1/posture/score | Requires entitlement control_plane.posture_score |
| POST | /v1/posture/snapshot | Requires entitlement control_plane.posture_score |
privacy 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/privacy/consent | List consent receipts (§28) |
| POST | /v1/privacy/consent | Record a consent receipt; honors Sec-GPC opt-out (§28) |
| POST | /v1/privacy/dsar/erase | Erase my data (right to erasure) |
| GET | /v1/privacy/dsar/export | Export my data (right of access) |
| GET | /v1/privacy/dsar/requests | DSAR register (cursor-paginated) |
rbac 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/rbac/roles | Requires entitlement control_plane.shell |
| POST | /v1/rbac/roles | Requires entitlement control_plane.shell |
| DELETE | /v1/rbac/roles/{name} | Requires entitlement control_plane.shell |
readyz 1
| Method | Path | Summary |
|---|---|---|
| GET | /readyz | Readiness probe (free-tier) |
release 7
| Method | Path | Summary |
|---|---|---|
| GET | /v1/release/assignment | Requires entitlement platform.release_channels |
| PUT | /v1/release/assignment | Requires entitlement platform.release_channels |
| GET | /v1/release/channels | Requires entitlement platform.release_channels |
| PUT | /v1/release/channels/{name} | Requires entitlement platform.release_channels |
| GET | /v1/release/pack | Requires entitlement platform.signed_release_pack |
| GET | /v1/release/parity | Requires entitlement platform.self_hosted_release_parity |
| POST | /v1/release/verify | Requires entitlement platform.signed_release_verification |
risk 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/risk/portfolio | Requires entitlement control_plane.risk_quant |
| GET | /v1/risk/scenarios | Requires entitlement control_plane.risk_quant |
| POST | /v1/risk/scenarios | Requires entitlement control_plane.risk_quant |
| DELETE | /v1/risk/scenarios/{id} | Requires entitlement control_plane.risk_quant |
roadmap 1
| Method | Path | Summary |
|---|---|---|
| GET | /v1/roadmap | §45 public roadmap (free-tier) |
scim 11
| Method | Path | Summary |
|---|---|---|
| POST | /scim/v2/Groups | Requires entitlement control_plane.shell |
| GET | /scim/v2/Groups/{id} | Requires entitlement control_plane.shell |
| PATCH | /scim/v2/Groups/{id} | Requires entitlement control_plane.shell |
| GET | /scim/v2/ResourceTypes | SCIM 2.0 ResourceTypes (RFC 7644 §4) |
| GET | /scim/v2/Schemas | SCIM 2.0 Schemas (RFC 7644 §4) |
| GET | /scim/v2/ServiceProviderConfig | SCIM 2.0 ServiceProviderConfig (RFC 7644 §4) |
| GET | /scim/v2/Users | List users (SCIM 2.0; filter=userName eq, pagination) |
| POST | /scim/v2/Users | Provision a user (SCIM 2.0) |
| DELETE | /scim/v2/Users/{id} | Deprovision a user (revokes sessions ≤60s) |
| GET | /scim/v2/Users/{id} | Requires entitlement control_plane.shell |
| PATCH | /scim/v2/Users/{id} | Requires entitlement control_plane.shell |
siem 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/siem/alerts | Requires entitlement control_plane.siem_hub |
| GET | /v1/siem/overview | Requires entitlement control_plane.siem_hub |
sla 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/sla/reports | Requires entitlement platform.sla_reporting |
| POST | /v1/sla/reports/generate | Requires entitlement platform.sla_reporting |
soar 13
| Method | Path | Summary |
|---|---|---|
| POST | /v1/soar/cacao/export | Requires entitlement control_plane.soar |
| POST | /v1/soar/cacao/import | Requires entitlement control_plane.soar |
| GET | /v1/soar/cases | Requires entitlement control_plane.case_management |
| POST | /v1/soar/cases | Requires entitlement control_plane.case_management |
| GET | /v1/soar/cases/{id} | Requires entitlement control_plane.case_management |
| PATCH | /v1/soar/cases/{id} | Requires entitlement control_plane.case_management |
| POST | /v1/soar/cases/{id}/assign | Requires entitlement control_plane.case_management |
| POST | /v1/soar/cases/{id}/escalate | Requires entitlement control_plane.case_management |
| GET | /v1/soar/cases/{id}/notes | Requires entitlement control_plane.case_management |
| POST | /v1/soar/cases/{id}/notes | Requires entitlement control_plane.case_management |
| POST | /v1/soar/cases/{id}/priority | Requires entitlement control_plane.case_management |
| POST | /v1/soar/cases/{id}/transition | Requires entitlement control_plane.case_management |
| POST | /v1/soar/playbooks/{id}/run | Requires entitlement control_plane.soar |
soc 6
| Method | Path | Summary |
|---|---|---|
| POST | /v1/soc/agents/execute | Requires entitlement control_plane.agentic_soc |
| POST | /v1/soc/agents/investigate | Requires entitlement control_plane.agentic_soc |
| POST | /v1/soc/agents/killswitch | Requires entitlement control_plane.agentic_soc |
| POST | /v1/soc/agents/killswitch/reset | Requires entitlement control_plane.agentic_soc |
| GET | /v1/soc/agents/model | Requires entitlement control_plane.agentic_soc |
| GET | /v1/soc/agents/scorecards | Requires entitlement control_plane.agentic_soc |
sovereignty 3
| Method | Path | Summary |
|---|---|---|
| GET | /v1/sovereignty/regions | Requires entitlement platform.sovereign_topology_api |
| PUT | /v1/sovereignty/residency | Requires entitlement platform.sovereign_topology_api |
| GET | /v1/sovereignty/topology | Requires entitlement platform.sovereign_topology_api |
sre 1
| Method | Path | Summary |
|---|---|---|
| GET | /v1/sre/dashboards | Requires entitlement platform.sre_dashboards |
status 6
| Method | Path | Summary |
|---|---|---|
| GET | /v1/status | §41 public status page (free-tier) |
| PATCH | /v1/status/components | Requires entitlement control_plane.shell |
| GET | /v1/status/incidents | §41 public incident history (free-tier) |
| POST | /v1/status/incidents | Requires entitlement control_plane.shell |
| POST | /v1/status/maintenance | Requires entitlement control_plane.shell |
| POST | /v1/status/subscriptions | §41 status subscriptions (free-tier) |
suite 9
| Method | Path | Summary |
|---|---|---|
| GET | /v1/suite/airgap-bundles | Requires entitlement suite.airgap_bundle_distribution |
| POST | /v1/suite/airgap-bundles | Requires entitlement suite.airgap_bundle_distribution |
| GET | /v1/suite/audit-pipeline | Requires entitlement suite.shared_audit_pipeline |
| GET | /v1/suite/licensing-client | Requires entitlement suite.shared_licensing_client |
| GET | /v1/suite/otel | Requires entitlement suite.shared_otel_collector |
| DELETE | /v1/suite/routes | Requires entitlement suite.cross_suite_routing |
| GET | /v1/suite/routes | Requires entitlement suite.cross_suite_routing |
| PUT | /v1/suite/routes | Requires entitlement suite.cross_suite_routing |
| GET | /v1/suite/shell-config | Requires entitlement suite.admin_shell_ui |
telemetry 4
| Method | Path | Summary |
|---|---|---|
| POST | /v1/telemetry/evaluate | Requires entitlement control_plane.telemetry_fabric |
| GET | /v1/telemetry/routes | Requires entitlement control_plane.telemetry_fabric |
| POST | /v1/telemetry/routes | Requires entitlement control_plane.telemetry_fabric |
| DELETE | /v1/telemetry/routes/{id} | Requires entitlement control_plane.telemetry_fabric |
tenants 6
| Method | Path | Summary |
|---|---|---|
| POST | /v1/tenants | Provision a tenant |
| DELETE | /v1/tenants/{id} | Requires entitlement control_plane.shell |
| GET | /v1/tenants/{id} | Get a tenant (RLS-scoped) |
| POST | /v1/tenants/{id}/export | Requires entitlement control_plane.shell |
| POST | /v1/tenants/{id}/resume | Requires entitlement control_plane.shell |
| POST | /v1/tenants/{id}/suspend | Requires entitlement control_plane.shell |
trust 2
| Method | Path | Summary |
|---|---|---|
| GET | /v1/trust/portal | §44 public trust portal (free-tier discovery) |
| GET | /v1/trust/portal/private | Requires entitlement platform.trust_portal_automation |
ueba 4
| Method | Path | Summary |
|---|---|---|
| GET | /v1/ueba/anomalies | Requires entitlement control_plane.ueba |
| GET | /v1/ueba/entities | Requires entitlement control_plane.ueba |
| GET | /v1/ueba/entities/{entity} | Requires entitlement control_plane.ueba |
| POST | /v1/ueba/scan | Requires entitlement control_plane.ueba |
updates 4
| Method | Path | Summary |
|---|---|---|
| POST | /v1/updates/apply | Requires entitlement control_plane.shell |
| GET | /v1/updates/check | Requires entitlement control_plane.shell |
| POST | /v1/updates/check | Requires entitlement control_plane.shell |
| GET | /v1/updates/status | Requires entitlement control_plane.shell |
webhooks 5
| Method | Path | Summary |
|---|---|---|
| GET | /v1/webhooks | Requires entitlement control_plane.shell |
| POST | /v1/webhooks | Requires entitlement control_plane.shell |
| GET | /v1/webhooks/deliveries | Requires entitlement control_plane.shell |
| POST | /v1/webhooks/deliveries/{id}/replay | Requires entitlement control_plane.shell |
| POST | /v1/webhooks/test | Requires entitlement control_plane.shell |
workloads 86
| Method | Path | Summary |
|---|---|---|
| GET | /v1/workloads/adm/clusters | Requires entitlement control_plane.app_dependency_map |
| DELETE | /v1/workloads/adm/clusters/{id} | Requires entitlement control_plane.app_dependency_map |
| GET | /v1/workloads/adm/clusters/{id} | Requires entitlement control_plane.app_dependency_map |
| PUT | /v1/workloads/adm/clusters/{id} | Requires entitlement control_plane.app_dependency_map |
| GET | /v1/workloads/adm/dependencies | Requires entitlement control_plane.app_dependency_map |
| POST | /v1/workloads/adm/discover | Requires entitlement control_plane.app_dependency_map |
| GET | /v1/workloads/annotations | Requires entitlement control_plane.inventory_enrichment |
| POST | /v1/workloads/annotations | Requires entitlement control_plane.inventory_enrichment |
| GET | /v1/workloads/cloud/accounts | Requires entitlement control_plane.cloud_enforcement |
| POST | /v1/workloads/cloud/accounts | Requires entitlement control_plane.cloud_enforcement |
| DELETE | /v1/workloads/cloud/accounts/{id} | Requires entitlement control_plane.cloud_enforcement |
| GET | /v1/workloads/cloud/state | Requires entitlement control_plane.cloud_enforcement |
| POST | /v1/workloads/cloud/sync | Requires entitlement control_plane.cloud_enforcement |
| GET | /v1/workloads/endpoints | Requires entitlement control_plane.endpoint_context |
| POST | /v1/workloads/endpoints/ingest | Requires entitlement control_plane.endpoint_context |
| GET | /v1/workloads/endpoints/summary | Requires entitlement control_plane.endpoint_context |
| DELETE | /v1/workloads/endpoints/{id} | Requires entitlement control_plane.endpoint_context |
| POST | /v1/workloads/enforcement/apply | Requires entitlement control_plane.segmentation_enforcement |
| POST | /v1/workloads/enforcement/compile | Requires entitlement control_plane.segmentation_enforcement |
| POST | /v1/workloads/enforcement/rollback | Requires entitlement control_plane.segmentation_enforcement |
| GET | /v1/workloads/enforcement/state | Requires entitlement control_plane.segmentation_enforcement |
| GET | /v1/workloads/enrichment/sources | Requires entitlement control_plane.inventory_enrichment |
| POST | /v1/workloads/enrichment/sources | Requires entitlement control_plane.inventory_enrichment |
| DELETE | /v1/workloads/enrichment/sources/{id} | Requires entitlement control_plane.inventory_enrichment |
| POST | /v1/workloads/enrichment/sources/{id}/sync | Requires entitlement control_plane.inventory_enrichment |
| GET | /v1/workloads/flows | Requires entitlement control_plane.flow_fabric |
| GET | /v1/workloads/flows/collector | Requires entitlement control_plane.flow_fabric |
| GET | /v1/workloads/flows/coverage | Requires entitlement control_plane.flow_fabric |
| GET | /v1/workloads/flows/exporters | Requires entitlement control_plane.flow_fabric |
| POST | /v1/workloads/flows/exporters | Requires entitlement control_plane.flow_fabric |
| DELETE | /v1/workloads/flows/exporters/{id} | Requires entitlement control_plane.flow_fabric |
| POST | /v1/workloads/flows/ingest | Requires entitlement control_plane.flow_fabric |
| GET | /v1/workloads/flows/topology | Requires entitlement control_plane.flow_fabric |
| POST | /v1/workloads/forensics/evaluate | Requires entitlement control_plane.workload_sensor |
| GET | /v1/workloads/forensics/events | Requires entitlement control_plane.workload_sensor |
| GET | /v1/workloads/forensics/rules | Requires entitlement control_plane.workload_sensor |
| POST | /v1/workloads/forensics/rules | Requires entitlement control_plane.workload_sensor |
| DELETE | /v1/workloads/forensics/rules/{id} | Requires entitlement control_plane.workload_sensor |
| GET | /v1/workloads/intent/export | Requires entitlement control_plane.policy_intent_egress |
| GET | /v1/workloads/intent/publications | Requires entitlement control_plane.policy_intent_egress |
| POST | /v1/workloads/intent/publish | Requires entitlement control_plane.policy_intent_egress |
| GET | /v1/workloads/intent/subscribers | Requires entitlement control_plane.policy_intent_egress |
| POST | /v1/workloads/intent/subscribers | Requires entitlement control_plane.policy_intent_egress |
| DELETE | /v1/workloads/intent/subscribers/{id} | Requires entitlement control_plane.policy_intent_egress |
| GET | /v1/workloads/inventory | Requires entitlement control_plane.software_inventory |
| POST | /v1/workloads/inventory/collect | Requires entitlement control_plane.software_inventory |
| POST | /v1/workloads/inventory/ingest | Requires entitlement control_plane.software_inventory |
| POST | /v1/workloads/k8s/apply | Requires entitlement control_plane.container_segmentation |
| GET | /v1/workloads/k8s/clusters | Requires entitlement control_plane.container_segmentation |
| POST | /v1/workloads/k8s/clusters | Requires entitlement control_plane.container_segmentation |
| DELETE | /v1/workloads/k8s/clusters/{id} | Requires entitlement control_plane.container_segmentation |
| POST | /v1/workloads/k8s/compile | Requires entitlement control_plane.container_segmentation |
| GET | /v1/workloads/k8s/state | Requires entitlement control_plane.container_segmentation |
| GET | /v1/workloads/metering | Requires entitlement control_plane.shell |
| POST | /v1/workloads/metering/record | Requires entitlement control_plane.shell |
| POST | /v1/workloads/policy/discover | Requires entitlement control_plane.segmentation_policy |
| GET | /v1/workloads/policy/policies | Requires entitlement control_plane.segmentation_policy |
| DELETE | /v1/workloads/policy/policies/{id} | Requires entitlement control_plane.segmentation_policy |
| GET | /v1/workloads/policy/policies/{id} | Requires entitlement control_plane.segmentation_policy |
| GET | /v1/workloads/policy/policies/{id}/diff | Requires entitlement control_plane.segmentation_policy |
| POST | /v1/workloads/policy/policies/{id}/publish | Requires entitlement control_plane.segmentation_policy |
| POST | /v1/workloads/policy/policies/{id}/rules | Requires entitlement control_plane.segmentation_policy |
| POST | /v1/workloads/policy/policies/{id}/validate | Requires entitlement control_plane.segmentation_policy |
| DELETE | /v1/workloads/policy/rules/{id} | Requires entitlement control_plane.segmentation_policy |
| GET | /v1/workloads/policy/violations | Requires entitlement control_plane.segmentation_policy |
| POST | /v1/workloads/policy/violations/{id}/ack | Requires entitlement control_plane.segmentation_policy |
| GET | /v1/workloads/processes | Requires entitlement control_plane.workload_sensor |
| POST | /v1/workloads/processes/baseline | Requires entitlement control_plane.workload_sensor |
| POST | /v1/workloads/processes/collect | Requires entitlement control_plane.workload_sensor |
| POST | /v1/workloads/processes/ingest | Requires entitlement control_plane.workload_sensor |
| POST | /v1/workloads/processes/verdicts | Requires entitlement control_plane.workload_sensor |
| GET | /v1/workloads/reports | Requires entitlement control_plane.workload_score |
| POST | /v1/workloads/risk/evaluate | Requires entitlement control_plane.workload_risk |
| GET | /v1/workloads/risk/fires | Requires entitlement control_plane.workload_risk |
| POST | /v1/workloads/risk/fires/{id}/execute | Requires entitlement control_plane.workload_risk |
| GET | /v1/workloads/risk/triggers | Requires entitlement control_plane.workload_risk |
| POST | /v1/workloads/risk/triggers | Requires entitlement control_plane.workload_risk |
| DELETE | /v1/workloads/risk/triggers/{id} | Requires entitlement control_plane.workload_risk |
| GET | /v1/workloads/score | Requires entitlement control_plane.workload_score |
| GET | /v1/workloads/score/history | Requires entitlement control_plane.workload_score |
| POST | /v1/workloads/score/snapshot | Requires entitlement control_plane.workload_score |
| GET | /v1/workloads/select | Requires entitlement control_plane.inventory_enrichment |
| POST | /v1/workloads/vuln-feed | Requires entitlement control_plane.software_inventory |
| POST | /v1/workloads/vuln-feed/pull | Requires entitlement control_plane.software_inventory |
| POST | /v1/workloads/vuln-scan | Requires entitlement control_plane.software_inventory |
| GET | /v1/workloads/vulnerabilities | Requires entitlement control_plane.software_inventory |
ztp 4
| Method | Path | Summary |
|---|---|---|
| POST | /v1/ztp/redeem | Requires entitlement control_plane.ztp |
| GET | /v1/ztp/tokens | Requires entitlement control_plane.ztp |
| POST | /v1/ztp/tokens | Requires entitlement control_plane.ztp |
| DELETE | /v1/ztp/tokens/{id} | Requires entitlement control_plane.ztp |