Skip to content

jman-api

jman-api is a lightweight, read-only REST API that serves the data cached by the jman CLI. This is useful for building dashboards or exposing your SpinupWP/Plugin data to other local services without needing to re-fetch from external APIs.

Running the API

You can build and run the API using:

make build
JMAN_API_PORT=8080 ./bin/jman-api

The API listens on the port specified by the JMAN_API_PORT environment variable.

Available Endpoints

The API reads directly from the local JSON cache generated by jman commands (e.g., jman fetch all).

  • GET /api/health - API health status and version.
  • GET /api/servers - Returns cached SpinupWP servers.
  • GET /api/sites - Returns cached SpinupWP sites.
  • GET /api/plugins - Returns all cached WordPress plugins across all sites.
  • GET /api/vulns?plugin=<slug> - Returns cached vulnerability data for a specific plugin.

Note: The API does not fetch new data. You must use the jman CLI to populate and update the cache.