Index
The S4E developer documentation provides everything you need to extend, integrate, and automate the S4E Continuous AI-Based Security Operations platform. Whether you are building custom integrations, writing automated workflows, or deploying on-premises agents, this section is your starting point.
What These Docs Cover
The developer documentation is organized into the following sections. Each section builds on the previous one, but you can jump directly to the topic most relevant to your use case.
Getting Started
Set up your development environment, obtain API credentials, and make your first authenticated request to the S4E API. This section covers prerequisites, authentication mechanisms, and a quickstart guide.
- Overview -- What you can build with S4E and the available integration options.
- Authentication -- API keys, OAuth 2.0, session tokens, scopes, and security best practices.
Guides
Step-by-step walkthroughs for common developer tasks such as creating custom scan profiles, automating vulnerability triage, integrating with third-party SIEM platforms, and building CI/CD pipeline checks.
Actions Development
Actions are reusable, event-driven components that execute in response to findings, asset changes, or scheduled triggers. Learn how to author, test, and publish custom actions within the S4E platform.
Playbook Development
Playbooks orchestrate sequences of actions into repeatable remediation and response workflows. This section explains the playbook schema, conditional logic, variable binding, and how to version and share playbooks across teams.
Agent / Opservant
Opservant is the S4E on-premises agent that enables internal network scanning, local asset discovery, and secure telemetry collection behind your firewall. The agent documentation covers installation, configuration, update policies, and communication with the S4E cloud or on-prem control plane.
SDK and CLI
The S4E SDK (Python) and CLI provide programmatic and command-line access to every platform capability. Use them to script bulk operations, integrate with automation frameworks, or embed S4E checks into your existing tooling.
Open Source
S4E maintains open-source projects including the Opservant autonomous security agent and community-driven playbooks. This section lists repositories, architecture, and contribution guidelines.
The S4E Developer Ecosystem
S4E is designed as an API-first platform. Every feature available in the web console is also accessible through the REST API, ensuring that developers have full parity when building integrations or automating operations.
The platform exposes multiple integration surfaces:
| Surface | Description |
|---|---|
| REST API | HTTPS endpoints for all platform operations. Base URL: https://api.s4e.io. |
| SDK | Python library wrapping the REST API with typed models and helper utilities. |
| CLI | Command-line interface for scripting and interactive use. |
| Webhooks | Push-based notifications for real-time event delivery. |
| Opservant | On-premises agent for internal scanning and asset discovery. |
Tip
If you are new to S4E development, start with the Overview to understand the platform capabilities, then proceed to Authentication to set up your credentials.
Prerequisites
Before diving into the developer docs, make sure you have:
- An active S4E account (cloud or on-premises).
- At least one workspace with the Developer or Admin role assigned to your user.
- Familiarity with REST APIs and JSON.
Note
On-premises deployments may have different base URLs and network requirements. Consult your platform administrator for environment-specific details.