Reference

API

Entry point for the SkyPort API docs and Swagger UI.

The API docs live behind the backend Swagger UI and should reflect the generated OpenAPI surface.

Access

terminal
http://localhost:8080/docs/index.html

Scope

  • health check
  • auth
  • metrics
  • VPS
  • terminal sessions
  • Docker
  • PM2
  • marketplace
  • proxy generation and mappings

Writing Guidance

Use the generated schema as the source of truth. Do not invent undocumented request or response fields in the docs site.

Next: Architecture

SkyPort

SkyPort Docs

Self-hosted infrastructure platform