API Reference

The User Workspaces Server provides a RESTful API for managing workspaces, jobs, users, and system resources. All endpoints use JSON for request and response payloads.

Authentication

The API uses custom token-based authentication with the UWS-Authorization header:

UWS-Authorization: <token>

Authentication Endpoints

Workspace Management

Workspaces represent user environments with isolated storage and compute access.

Shared Workspace Management

Collaborative workspace features for sharing between users.

Job Management

Jobs represent computational tasks executed within workspaces.

Job Type Information

Information about available job types and their parameters.

User Management

User information, quotas, and authentication details.

System Information

System status and configuration information.

Parameter Validation

Parameter and configuration validation endpoints.

WebSocket Support

Real-time communication for job status updates and interactive sessions.

Passthrough Proxy

HTTP proxy for forwarding requests to running jobs.

Data Models

Core data models used by the API.

Serializers

Request/response serialization classes.