Skip to main content

ShieldOps Documentation

Everything you need to deploy, configure, and extend the ShieldOps platform.

Search documentation…⌘K

Demo layout — replace links with your real documentation

Quick Start

Up and running in under 10 minutes. Deploy the agent, connect your first integration, and see live data.

  • Install the agent
  • Connect your SIEM
  • Alert triage workflow
  • Your first playbook

Guides

Step-by-step walkthroughs for common workflows and advanced configurations.

  • SOC 2 readiness
  • Ransomware playbook
  • Vulnerability management
  • UEBA tuning
  • Custom detection rules

API Reference

Complete REST API documentation with request/response examples, pagination, and rate limits.

  • Authentication
  • Threat feed API
  • Alerts API
  • Vulnerability scanning API
  • Webhooks

Integrations

Connect ShieldOps to your existing stack. 300+ integrations with step-by-step setup guides.

  • SIEM Connector
  • EDR Platform
  • Identity Provider
  • Cloud Security Hub

Platform

Architecture deep-dives, data retention, SSO setup, and platform administration.

  • SSO / SAML config
  • Data retention
  • Access control & IAM
  • Compliance dashboard
  • Permissions & roles
  • Audit logs

SDKs & CLIs

Official SDKs for Python, Node.js, Go, and Java. Plus the ShieldOps CLI for automation.

  • Python SDK
  • Node.js SDK
  • Go SDK
  • CLI reference