Skip to content
osctrl
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
1. Components
Overview
osctrl-tls
osctrl-api
osctrl-mcp
osctrl-frontend
osctrl-cli
nginx
Backend
Metrics
osctrld
2. Deployment
Overview
Using Docker
Install on Ubuntu
3. Configuration
Configuration
4. Usage
Overview
osctrl-tls
osctrl-api
osctrl-mcp
Roles and permissions
Vulnerability monitoring
Santa sync server
Per-node overrides
osquery extensions
Auth providers
osctrl-cli
Overview
alert
audit-logs
carve
check-api
check-db
environment
login
node
query
settings
shell
tag
tui
user
osctrld
osctrld daemon
osquery upgrades
provision.sh
5. Contributing
Contributing
osctrl-api (OpenAPI)
Overview
system
API root liveness check
API error response
API forbidden response
API health check
alerts
Apply alert changes (hot reload)
List alert channels
Create an alert channel
Get one alert channel
Update an alert channel
Delete an alert channel
Test an alert channel
List supported alert channel types
Recent alert history
List alert rules
Create an alert rule
Get one alert rule
Update an alert rule
Delete an alert rule
queries
List queries
List queries
Run query
Execute query action
Get query
List paginated queries
Get query results
Export query results CSV
List query samples
audit
List audit logs
auth-providers
Fetch IdP metadata XML
auth
Complete OIDC login
Start OIDC login