Skip to content

🌍 REST API Reference

CyProLib includes a built-in FastAPI server for automation.

Starting the Server

cypro serve

The API will be available at http://localhost:8000.

Endpoints

Method Endpoint Description
GET / Health check.
POST /scan/network Start a background network scan.
POST /scan/web Run a web vulnerability scan.

Swagger UI

Visit http://localhost:8000/docs for the interactive API dashboard.