Skip to main content

​
API Overview

The NeoSC API provides programmatic access to all features of the Neogenesys Secure Connect platform, including user management, workspace orchestration, session handling, and security policy enforcement.

​
Base URL

All API endpoints are prefixed with /api: 
https://your-domain.com/api
For local development: 
http://localhost:8000/api

​
API Version

Current API version: 1.0.0 The API version is included in the root endpoint response: 
curl https://your-domain.com/api
Response
{
  "message": "NeoSC API - Neogenesys Secure Connect",
  "version": "1.0.0"
}

​
Technology Stack

The NeoSC API is built with:
  • FastAPI - High-performance async web framework
  • MongoDB - Document database for data persistence
  • Pydantic - Data validation and serialization
  • Motor - Async MongoDB driver

​
Request Format

All API requests should include:
  • Content-Type: application/json header for POST/PUT/PATCH requests
  • Authorization: Bearer <token> header for authenticated endpoints
Example request: 
curl -X POST https://your-domain.com/api/workspaces/ws-123/launch \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your-token-here"

​
Response Format

All API responses are returned in JSON format with appropriate HTTP status codes.

​
Success Response

{
  "message": "Operation successful",
  "data": { ... }
}

​
Error Response

{
  "detail": "Error message describing what went wrong"
}

​
HTTP Status Codes

Status CodeDescription
200Success - Request completed successfully
201Created - Resource created successfully
400Bad Request - Invalid parameters or request format
401Unauthorized - Missing or invalid authentication
403Forbidden - Insufficient permissions
404Not Found - Resource does not exist
500Internal Server Error - Server-side error
502Bad Gateway - External service error

​
Rate Limiting

Currently, the API does not enforce rate limiting. This may be added in future versions.

​
CORS Configuration

CORS is configured via the CORS_ORIGINS environment variable. The API supports:
  • Credentials: true
  • Methods: All HTTP methods
  • Headers: All headers

​
Next Steps

Authentication

Learn how to authenticate API requests

Users

Manage user accounts and profiles

Workspaces

Create and manage secure workspaces

Sessions

Handle workspace sessions

​
System Endpoints

​
Health Check

Check if the API is running and responding. 
GET /api/
Response: 
{
  "message": "NeoSC API - Neogenesys Secure Connect",
  "version": "1.0.0"
}
This endpoint does not require authentication and can be used for health checks and monitoring.

​
Platform Statistics

Get real-time platform statistics including active sessions, users, and workspaces. 
GET /api/stats
Authentication: Required Response: 
{
  "active_sessions": 12,
  "total_workspaces": 5,
  "total_users": 28,
  "security_score": 98,
  "uptime": "99.9%"
}
​
active_sessions
integer
Number of currently active workspace sessions
​
total_workspaces
integer
Total number of available workspaces
​
total_users
integer
Total number of registered users
​
security_score
integer
Overall security health score (0-100)
​
uptime
string
Platform uptime percentage
Example: 
curl https://your-domain.com/api/stats \
  -H "Authorization: Bearer your-token-here"

Build docs developers (and LLMs) love

Get started for freeTalk to us