API Documentation - jesec/flood GitHub Wiki

API Documentation

Flood exposes an OpenAPI spec and a Swagger UI for its HTTP API.

Endpoints

  • Swagger UI: /api/docs
  • OpenAPI JSON: /openapi.json (also available at /api/openapi.json)

If you run Flood with a base URI (for example --baseuri=/flood), the endpoints move under that prefix:

  • Swagger UI: /flood/api/docs
  • OpenAPI JSON: /flood/openapi.json (also available at /flood/api/openapi.json)

Authentication

The API uses the same cookie-based authentication as the web UI. Log in first to get the jwt cookie before using the docs UI or making API requests.