FlagdeckFlagdeck
Pricing
Docs
Get Started

Documentation

Flags

Flags live under a project. All endpoints require flags:read or flags:write.

List flags

GET /v1/projects/{projectId}/flags (scope: flags:read)

Supports page, limit and search.

Get a flag

GET /v1/projects/{projectId}/flags/{key} (scope: flags:read)

Create a flag

POST /v1/projects/{projectId}/flags (scope: flags:write)

FieldTypeRequiredDefault
keystring, lowercase dot/hyphen segments (checkout.new-banner)yes
namestringyes
descriptionstringno
valueTypeboolean | string | number | jsonnoboolean
defaultValuematches valueTypeno
statusactive | inactivenoactive

bash

curl -X POST https://api.flagdeck.com/v1/projects/PROJECT_ID/flags \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "key": "checkout.new-banner", "name": "New checkout banner" }'

New flags are created disabled in every environment.

Update a flag

PATCH /v1/projects/{projectId}/flags/{key} (scope: flags:write)

Toggle a flag

POST /v1/projects/{projectId}/flags/{key}/toggle (scope: flags:write)

Archive a flag

POST /v1/projects/{projectId}/flags/{key}/archive (scope: flags:write)

Duplicate a flag

POST /v1/projects/{projectId}/flags/{key}/duplicate (scope: flags:write)

Delete a flag

DELETE /v1/projects/{projectId}/flags/{key} (scope: flags:write)