feature_flags

Create, read, update and delete feature flags. See docs for more information on feature flags.

If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.

get/api/projects/{project_id}/feature_flags/{id}/status/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/feature_flags/{id}/status/
  • Auth: HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this feature flag.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

statusstring required

Staleness classification: active, stale, archived, deleted, or unknown. This is not the serving state, and this response carries no serving-state field: read the active field of the flag itself from the list or retrieve endpoint. A disabled flag that is not archived or deleted reports 'active', because disabled flags are not evaluated for staleness. 'active' also does NOT mean the flag is fully rolled out. Use the rollout object to determine rollout completeness.

reasonstring required

Human-readable explanation of the status

reason_states_rolloutboolean required

True when reason already describes the flag's rollout, which happens when the status was reached from the configuration rather than from evaluation data. A caller that narrates the rollout separately should stay quiet rather than repeat it.

Changes

No recorded changes to this operation across all 1 revision of this API.