REST API

Overview

The FlagForge REST API is the HTTP control plane served by @flagforge/api. Operators use server-authenticated endpoints to manage projects, environments, typed feature flags, segments, webhooks, and audit logs. Applications and the TypeScript SDK use client-authenticated endpoints to bootstrap flag definitions or evaluate flags for an evaluation context.

The API also serves an interactive Swagger UI at /docs and an OpenAPI 3.1 document at /openapi.json. Use these endpoints to inspect the live contract and try requests against a running local API.

Base URL

The verified local development server URL is:

http://localhost:4000

Append the versioned paths in the resource table to this base URL. For example, the project collection is http://localhost:4000/v1/projects.

Authentication

Management endpoints use Bearer server API keys, while evaluation and configuration endpoints use Bearer client API keys. The health and documentation endpoints require no authentication; see Authentication for the supported API-key schemes and authorization rules.

Resources

The following table lists the public routes exposed by the API. Paths beginning with /v1 are versioned API routes.

Successful and failed requests use the route-specific schemas exposed in the OpenAPI document. API errors use a uniform envelope with an error code and message, such as:

{
  "error": {
    "code": "not_found",
    "message": "Flag \"checkout\" not found."
  }
}