API Reference
Complete API documentation for all TWNstack products.
Authentication
All API requests require authentication using API keys passed in the Authorization header:
Authorization: Bearer your-api-key
Base URLs
- Production:
https://api.twnstack.com/v1 - Staging:
https://api-staging.twnstack.com/v1
CreatureGRC API
Compliance Endpoints
GET /compliance/frameworks- List available compliance frameworksPOST /compliance/assessments- Create new compliance assessmentGET /compliance/assessments/:id- Get assessment details
Risk Management
GET /risks- List all risksPOST /risks- Create new risk entryPUT /risks/:id- Update risk status
OpenSentinel API
Monitoring
GET /monitors- List active monitorsPOST /alerts- Create alert ruleGET /logs/query- Query system logs
Incident Response
POST /incidents- Create incidentGET /incidents/:id- Get incident detailsPOST /incidents/:id/resolve- Resolve incident
SOAPBOX API
Campaigns
GET /campaigns- List marketing campaignsPOST /campaigns- Create new campaignPUT /campaigns/:id- Update campaign
Analytics
GET /analytics/overview- Get marketing analyticsGET /analytics/conversion- Conversion tracking data
Rate Limits
- Standard: 100 requests/minute
- Enterprise: 1000 requests/minute
Error Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Internal Server Error |
Getting Started with TWNStack
Quick start guides and tutorials for TWNStack products. Learn how to deploy and configure CreatureGRC, OpenSentinel, and SOAPBOX in minutes.
System Architecture & Design
System architecture, design patterns, and technical deep dives. Understand how TWNstack products are built and how components interact.