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
Complete SAML login
Start SAML login
Get SAML metadata
Log in
Log in
List login environments
Complete a login with a second factor
Begin enrollment during login
Finish enrollment during login
Begin a WebAuthn login ceremony
Finish a WebAuthn login ceremony
Log out
carves
List file carves
Run file carve
Execute carve action
Get file carve
Download carve archive
List file carves
List carve queries
List carve samples
checks
Authenticated API check
Unauthenticated API check
environments
List environments
Create environment
Get environment
Delete environment
Update environment
Execute enrollment action
Get enrollment values
List enrolling packages
Add enrolling package
Remove enrolling package
Execute removal action
Get removal values
Execute environment action
Get environment config
Update environment config
Update environment expiration
Get environment extensions
Assign extension to environment
Remove extension from environment
Get environment inactivity threshold
Set environment inactivity threshold
Reset environment inactivity threshold
Update environment intervals
Map environments
Get environment osquery target
Set environment osquery target
Clear environment osquery target