CookieFarm
Server

API Reference

Main REST endpoints exposed by CookieFarm server.

API Reference

Swagger / OpenAPI

CookieFarm now exposes generated Swagger docs directly from server:

  • Swagger UI: /api/v1/swagger
  • OpenAPI JSON: /api/v1/swagger/doc.json

In Fumadocs, the same schema is rendered with the OpenAPI API Page integration:

  • Docs API page: /docs/server/openapi

Generated spec files are versioned in:

  • cookiefarm/server/api/docs/swagger.json
  • cookiefarm/server/api/docs/swagger.yaml

How is this guide?

Communication Protocol Guide

Build CookieFarm protocol plugins to submit flags to the Flag Checker service, parse JSON responses, and handle errors reliably.

API status GET

Returns a simple status response to confirm the server is online.

On this page

API ReferenceSwagger / OpenAPI