Integrations

REST API Reference

6 min read

The FlagPilot REST API gives you direct, low-level access to flag management. Use it to automate flag lifecycle events from CI/CD pipelines, server-side scripts, or any environment without an official SDK.

Authentication

All API requests must include your API key in the Authorization header:

Terminal
curl -X GET \
  https://api.tryflagpilot.com/v1/flags \
  -H "Authorization: Bearer fk_secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Endpoints

MethodEndpointDescription
GET/v1/flagsList all flags in the project
POST/v1/flagsCreate a new feature flag
GET/v1/flags/:keyGet a single flag by key
PATCH/v1/flags/:keyUpdate flag settings, rollout, or toggle state
DELETE/v1/flags/:keyPermanently delete a flag
GET/v1/flags/:key/evaluateEvaluate a flag for a specific user context
GET/v1/flags/:key/usersList targeted users for a flag
POST/v1/flags/:key/usersAdd user IDs to the target list
DELETE/v1/flags/:key/users/:idRemove a user from the target list
GET/v1/flags/:key/sdk-healthGet SDK health telemetry for a flag

Example: Toggle a flag

Use the PATCH /v1/flags/:key endpoint to toggle a flag on or off:

Terminal
curl -X PATCH \
  https://api.tryflagpilot.com/v1/flags/checkout-redesign \
  -H "Authorization: Bearer fk_secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

Rate limits

FlagPilot does not enforce a per-minute request rate limit. Instead, the Free plan has a monthly flag-evaluation quota:

PlanMonthly Evaluation Quota
Free50,000 / mo (105% grace buffer, then 403 quota_exceeded)
Solo500,000 / mo, then metered overage
Pro2,000,000 / mo, then metered overage
Business20,000,000 / mo, then metered overage
Was this page helpful?