Skip to main content

API Overview

disaster-server exposes REST APIs, Watch APIs, authentication, statistics, events, and OpenAPI documentation.

Swagger / OpenAPI​

The project includes Swagger / OpenAPI documentation. When swagger.enabled=true, server registers:

  • GET /swagger/
  • GET /openapi.yaml
  • GET /openapi.json

The OpenAPI contract source is disaster-server/openspec/specs/disaster-server-openapi.yaml. For enablement, export, and maintenance rules, see Swagger / OpenAPI Documentation.

API Style​

Most business APIs are under /apis/.... Some compatibility routes may exist under /api/....

Common Groups​

  • Authentication: /login, /refresh_token.
  • Instances: /apis/disasterinstances.testudo.softcdata.com/v1/instances.
  • Groups: /apis/disastergroups.testudo.softcdata.com/v1/groups.
  • Drills: /apis/disasterdrills.testudo.softcdata.com/v1/drills.
  • Clusters: /apis/cluster.testudo.softcdata.com/v1/clusters.
  • Storage: /apis/storage.testudo.softcdata.com/v1/storages.
  • Events: /apis/v1/events.
  • Statistics: /apis/backuprestorestatistics.testudo.softcdata.com/v1/....

Watch APIs​

Watch APIs stream changes for console and automation use cases. They should be treated as real-time views over CRDs and Events, not as a separate state store.