API Reference
API Reference
Programmatic access to SOC Simulator for enterprise integrations.
API Reference
The SOC Simulator API is available for Enterprise customers only. Contact sales@socsimulator.com for access.
Overview
The SOC Simulator API enables programmatic access to:
- User progress and statistics
- Training room management
- Alert generation and management
- Team performance analytics
- Custom scenario creation
Authentication
All API requests require authentication via API key:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.socsimulator.com/v1/users/meBase URL
https://api.socsimulator.com/v1Rate Limits
| Plan | Requests/minute |
|---|---|
| Enterprise | 1000 |
| API Trial | 60 |
Endpoints
Users
| Method | Endpoint | Description |
|---|---|---|
GET | /users/me | Get current user |
GET | /users/:id/stats | Get user statistics |
GET | /users/:id/progress | Get MITRE ATT&CK progress |
Teams
| Method | Endpoint | Description |
|---|---|---|
GET | /teams | List teams |
GET | /teams/:id | Get team details |
GET | /teams/:id/members | List team members |
GET | /teams/:id/analytics | Team performance |
Rooms
| Method | Endpoint | Description |
|---|---|---|
GET | /rooms | List available rooms |
GET | /rooms/:id | Get room details |
POST | /rooms | Create custom room |
GET | /rooms/:id/completions | Room completion stats |
Alerts
| Method | Endpoint | Description |
|---|---|---|
GET | /alerts | List alerts |
POST | /alerts | Create alert |
GET | /alerts/:id | Get alert details |
PATCH | /alerts/:id | Update alert status |
Shifts
| Method | Endpoint | Description |
|---|---|---|
GET | /shifts | List shifts |
POST | /shifts | Start new shift |
GET | /shifts/:id | Get shift details |
POST | /shifts/:id/end | End shift |
Response Format
All responses are JSON:
{
"data": { ... },
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"request_id": "req_abc123"
}
}Error Handling
{
"error": {
"code": "unauthorized",
"message": "Invalid API key",
"status": 401
}
}| Status | Description |
|---|---|
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
429 | Rate limited |
500 | Server error |
SDKs
Official SDKs are available for:
- Python -
pip install socsimulator - JavaScript/TypeScript -
npm install @socsimulator/sdk - Go -
go get github.com/socsimulator/go-sdk
Webhooks
Configure webhooks to receive real-time events:
shift.started- User started a shiftshift.ended- Shift completedroom.completed- Room finishedalert.escalated- Alert was escalated
Support
- Documentation: You're here!
- API Status: status.socsimulator.com
- Support: api-support@socsimulator.com
- Enterprise Sales: sales@socsimulator.com