Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.osmedeus.org/llms.txt

Use this file to discover all available pages before exploring further.

​
Workspaces

​
List Workspaces

Get a list of all run workspaces with full metadata. List workspaces from database (default): 
curl http://localhost:8002/osm/api/workspaces \
  -H "Authorization: Bearer $TOKEN"
List workspaces with pagination: 
curl "http://localhost:8002/osm/api/workspaces?offset=0&limit=50" \
  -H "Authorization: Bearer $TOKEN"
List workspaces from filesystem/assets: 
curl "http://localhost:8002/osm/api/workspaces?filesystem=true" \
  -H "Authorization: Bearer $TOKEN"
Combine pagination with filesystem mode: 
curl "http://localhost:8002/osm/api/workspaces?filesystem=true&offset=20&limit=10" \
  -H "Authorization: Bearer $TOKEN"
Response (database mode): 
{
  "data": [
    {
      "id": 1,
      "name": "example.com",
      "local_path": "/home/user/osmedeus-base/workspaces/example.com",
      "total_assets": 150,
      "total_subdomains": 120,
      "total_urls": 500,
      "total_vulns": 12,
      "vuln_critical": 2,
      "vuln_high": 3,
      "vuln_medium": 4,
      "vuln_low": 3,
      "vuln_potential": 0,
      "risk_score": 7.5,
      "tags": ["production", "priority"],
      "last_run": "2025-01-15T10:30:00Z",
      "run_workflow": "subdomain-enum",
      "created_at": "2025-01-10T08:00:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "test.com",
      "local_path": "/home/user/osmedeus-base/workspaces/test.com",
      "total_assets": 50,
      "total_subdomains": 35,
      "total_urls": 120,
      "total_vulns": 3,
      "vuln_critical": 0,
      "vuln_high": 1,
      "vuln_medium": 2,
      "vuln_low": 0,
      "vuln_potential": 5,
      "risk_score": 4.2,
      "tags": ["staging"],
      "last_run": "2025-01-14T15:00:00Z",
      "run_workflow": "port-scan",
      "created_at": "2025-01-12T12:00:00Z",
      "updated_at": "2025-01-14T15:00:00Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 20
  }
}
Workspace Fields Reference:
FieldTypeDescription
idintUnique workspace identifier
namestringWorkspace name (usually the target domain)
local_pathstringFull path to workspace directory
total_assetsintTotal discovered assets
total_subdomainsintTotal discovered subdomains
total_urlsintTotal discovered URLs
total_vulnsintTotal vulnerabilities found
vuln_criticalintCritical severity vulnerabilities
vuln_highintHigh severity vulnerabilities
vuln_mediumintMedium severity vulnerabilities
vuln_lowintLow severity vulnerabilities
vuln_potentialintPotential/informational findings
risk_scorefloatCalculated risk score (0-10)
tagsarrayCustom tags for organization
last_runtimestampLast workflow run timestamp
run_workflowstringName of last executed workflow
state_execution_logstringPath to execution log file
state_completed_filestringPath to completed marker file
state_workflow_filestringPath to workflow YAML file
state_workflow_folderstringPath to workflow folder
created_attimestampWorkspace creation timestamp
updated_attimestampLast update timestamp

​
List Workspace Names

Get a lightweight list of workspace names only (without full metadata). 
curl http://localhost:8002/osm/api/workspace-names \
  -H "Authorization: Bearer $TOKEN"
Response: 
{
  "data": [
    "example.com",
    "test.com",
    "demo.org"
  ],
  "count": 3
}

​
Get Workspace State File

Retrieve the content of a workspace state file. This endpoint provides access to execution logs, completion markers, and workflow files associated with a workspace. Get execution log: 
curl "http://localhost:8002/osm/api/workspaces/example.com/state-file?state_file=execution_log" \
  -H "Authorization: Bearer $TOKEN"
Get completed file: 
curl "http://localhost:8002/osm/api/workspaces/example.com/state-file?state_file=completed_file" \
  -H "Authorization: Bearer $TOKEN"
Get workflow file: 
curl "http://localhost:8002/osm/api/workspaces/example.com/state-file?state_file=workflow_file" \
  -H "Authorization: Bearer $TOKEN"
Response: 
{
  "workspace": "example.com",
  "state_file": "execution_log",
  "file_path": "/home/user/osmedeus-base/workspaces/example.com/log/execution.log",
  "content": "2025-01-15 10:30:00 [INFO] Starting workflow...\n2025-01-15 10:30:05 [INFO] Step 1 completed...\n..."
}
State File Types:
TypeDescription
execution_logDetailed execution log with timestamps and step output
completed_fileMarker file indicating workflow completion status
workflow_fileThe YAML workflow definition that was executed
Error Responses:
StatusDescription
400Invalid workspace name or missing state_file parameter
403Path traversal attempt detected
404Workspace or state file not found