> ## Documentation Index > Fetch the complete documentation index at: https://docs.growthbook.io/llms.txt > Use this file to discover all available pages before exploring further. # Partially update a feature > **Deprecated.** Use [POST /v2/features/:id](#operation/updateFeatureV2) instead. Updates the Feature Flag and immediately publishes a new revision. The caller needs Edit access in the Feature Flag's Project and Publish access for every affected environment. When approval is required, use the revision endpoints instead, unless the caller can bypass draft approvals. ## OpenAPI ````yaml openapi.yaml POST /v1/features/{id} openapi: 3.1.0 info: version: 5.1.0 title: GrowthBook REST API description: > GrowthBook offers a full REST API for interacting with the application. Request data can use either JSON or Form data encoding (with proper `Content-Type` headers). All response bodies are JSON-encoded. The API base URL for GrowthBook Cloud is `https://api.growthbook.io/api`. For self-hosted deployments, it is the same as your API_HOST environment variable (defaults to `http://localhost:3100/api`). The rest of these docs will assume you are using GrowthBook Cloud. ## Versioning Endpoints are versioned by path prefix: - `/v1/...` — stable, widely-supported endpoints - `/v2/...` — updated endpoints with improved shapes (e.g. unified per-rule environment scope for feature flags) New integrations should prefer v2 where available. ## Authentication We support both the HTTP Basic and Bearer authentication schemes for convenience. You first need to generate a new API Key in GrowthBook. Different keys have different permissions: - **Personal Access Tokens**: These are sensitive and provide the same level of access as the user has to an organization. These can be created by going to `Personal Access Tokens` under the your user menu. - **Secret Keys**: These are sensitive and provide the level of access for the role, which currently is either `admin` or `readonly`. Only Admins with the `manageApiKeys` permission can manage Secret Keys on behalf of an organization. These can be created by going to `Settings -> API Keys` If using HTTP Basic auth, pass the Secret Key as the username and leave the password blank (when using curl, add `:` at the end of the secret to indicate an empty password) ```bash curl https://api.growthbook.io/api/v1/features \ -u secret_abc123DEF456: ``` If using Bearer auth, pass the Secret Key as the token: ```bash curl https://api.growthbook.io/api/v1/features \ -H "Authorization: Bearer secret_abc123DEF456" ``` ## Errors The API may return the following error status codes: - **400** - Bad Request - Often due to a missing required parameter - **401** - Unauthorized - No valid API key provided - **402** - Request Failed - The parameters are valid, but the request failed - **403** - Forbidden - Provided API key does not have the required access - **404** - Not Found - Unknown API route or requested resource - **422** - Unprocessable Entity - The request is valid, but a warning, validation rule, approval requirement, or another publishing gate blocked it. Do not assume that `ignoreWarnings` clears every 422 response. - **429** - Too Many Requests - You exceeded the rate limit of 60 requests per minute. Try again later. - **5XX** - Server Error - Something went wrong on GrowthBook's end (these are rare) The response body will be a JSON object with the following properties: - **message** - Information about the error ### Publishing gates Publish responses include a `gates` array that explains every blocker: - `type`, `severity`, and `messages` identify the problem. - `override` names the request-body field that can bypass it. This is `ignoreWarnings` for warnings, `skipSchemaValidation` for schema and invariant failures, or `skipHooks` for Custom Hook rejections. A value of `null` means there is no request-body override. - `requiresPermission` identifies any additional permission needed to use the override. - `resolution` provides an API action, method, and path when the blocker must be resolved another way. For example, an approval gate is cleared by approving the revision or by using a caller with **Bypass draft approvals** access. A Config lock is cleared through the unlock route in `resolution`. When a successful publish bypasses a gate, the response includes `bypassedGates`. Each entry reports the gate `type` and how it was bypassed in `via`, which is one of `ignoreWarnings`, `skipSchemaValidation`, `skipHooks`, `bypassApprovalPermission`, `restApiBypassesReviews`, or `revertsBypassApproval` (reverts only). This field is omitted when no gates were bypassed. servers: - url: https://api.growthbook.io/api description: GrowthBook Cloud - url: https://{domain}/api description: Self-hosted GrowthBook variables: domain: default: localhost:3100 description: Your self-hosted GrowthBook host (and port) security: - bearerAuth: [] - basicAuth: [] tags: - name: projects x-displayName: Projects description: Projects are used to organize your feature flags and experiments - name: environments x-displayName: Environments description: >- GrowthBook comes with one environment by default (production), but you can add as many as you need. When used with feature flags, you can enable/disable feature flags on a per-environment basis. - name: features-v2 x-displayName: Feature Flags description: >- Control your feature flags programmatically. Rules are returned as a unified top-level array; each rule carries `allEnvironments` / `environments` scope fields instead of being bucketed by environment. - name: feature-revisions-v2 x-displayName: Feature Revisions description: >- Draft revisions for feature flags, including rules, scheduling, and approval workflows. Revision `rules` is a flat array with per-rule scope fields. - name: features x-displayName: Feature Flags (legacy) description: >- Control your feature flags programmatically. **These are v1 endpoints.** New integrations should use the v2 Feature Flags endpoints, which expose a unified per-rule environment scope instead of per-environment rule arrays. - name: feature-revisions x-displayName: Feature Revisions (legacy) description: >- Draft revisions for feature flags, including rules, scheduling, and approval workflows. **These are v1 endpoints.** New integrations should use the v2 Feature Revisions endpoints. - name: ramp-schedules x-displayName: Ramp Schedules description: >- Multi-step rollout schedules that gradually increase feature rule traffic over time, with optional real-time monitoring. Each step supports interval timers, approval gates, and hold conditions. Monitored steps are backed by a live analysis experiment that can automatically hold, roll back, or advance the ramp based on guardrail and signal metric health. - name: data-sources x-displayName: Data Sources description: >- How GrowthBook connects and queries your data, including cached database schema metadata (information schemas) for tables and columns. - name: fact-tables x-displayName: Fact Tables description: Fact Tables describe the shape of your data warehouse tables - name: fact-metrics x-displayName: Fact Metrics description: Fact Metrics are metrics built on top of Fact Table definitions - name: metrics x-displayName: Metrics (legacy) description: Metrics used as goals and guardrails for experiments - name: experiments x-displayName: Experiments description: Experiments (A/B Tests) - name: namespaces x-displayName: Namespaces description: >- Namespaces partition your user population into buckets so that experiments using the same hash attribute do not overlap unintentionally. Each namespace defines a 0–1 range and individual experiments claim sub-ranges within it. - name: snapshots x-displayName: Experiment Snapshots description: Experiment Snapshots (the individual updates of an experiment) - name: dimensions x-displayName: Dimensions description: Dimensions used during experiment analysis - name: segments x-displayName: Segments description: Segments used during experiment analysis - name: reports x-displayName: Experiment Reports description: >- Custom analysis reports built on top of experiment snapshots. Reports let you re-run analysis with different metrics, date ranges, stats engines, and other settings without modifying the underlying experiment. - name: sdk-connections x-displayName: SDK Connections description: Client keys and settings for connecting SDKs to a GrowthBook instance - name: visual-changesets x-displayName: Visual Changesets description: Groups of visual changes made by the visual editor to a single page - name: saved-groups x-displayName: Saved Groups description: >- Defined sets of attribute values which can be used with feature rules for targeting features at particular users. - name: saved-group-revisions x-displayName: Saved Group Revisions description: >- Draft revisions for saved groups, including pending changes, approvals, and lifecycle (publish, discard, revert). Most callers can interact with these endpoints via shorthand actions (`/items/add`, `/items/remove`, single-field PUTs) instead of authoring JSON Patch ops directly. Pass `version: "new"` on edit endpoints to auto-create a draft. - name: constants x-displayName: Constants description: >- **Beta** — these endpoints are new and may change in backwards-incompatible ways. Reusable named values referenced from feature flag values as `@const:key` and resolved into the SDK payload at build time. String constants are interpolated via `{{ @const:key }}`; JSON (object) constants are composed via an `$extends` array. A constant's own keys **replace** what its `$extends` bases provide, wholesale — constants are atomic building blocks. (Config and feature values compose as deep, targeted patches instead.) - name: constant-revisions x-displayName: Constant Revisions description: >- **Beta** — these endpoints are new and may change in backwards-incompatible ways. Draft revisions for constants, including pending changes, approvals, and lifecycle (publish, discard, revert). Pass `version: "new"` on edit endpoints to auto-create a draft. - name: configs x-displayName: Configs description: >- **Beta** — these endpoints are new and may change in backwards-incompatible ways. Reusable, typed, inheritable JSON objects referenced from feature flag values as `@config:key`. A config carries a field `schema` (with TypeScript/JSON Schema import-export) and a lineage `parent`. Inheritance is expressed via `parent`, never an in-value `@config:` entry. Values layer as a **deep, targeted patch**: a child (or a config-backed feature value) restates only the leaves it changes and inherits the rest — unlike a constant's `$extends`, whose own keys replace wholesale. Schema fields colliding with a published ancestor's key follow 'base wins': identical re-declarations are stripped with a warning, differing ones are rejected. - name: config-revisions x-displayName: Config Revisions description: >- **Beta** — these endpoints are new and may change in backwards-incompatible ways. Draft revisions for configs, including value and schema edits, schema import (JSON Schema / TypeScript / inferred), approvals, and lifecycle (publish, discard, revert). Publishing a schema change cascades the "base wins" normalization to descendant configs; a publish that removes or retypes fields descendants still use soft-blocks with a 422 unless the request body sets `ignoreWarnings: true`. Pass `version: "new"` on edit endpoints to auto-create a draft. - name: releases x-displayName: Releases description: >- **Beta** — these endpoints are new and may change in backwards-incompatible ways. Coordinated multi-entity publishing: publish a set of revisions across Feature Flags, Saved Groups, configs, and constants as one all-or-nothing operation, validated against the combined end-state instead of each in-between state. Requires the `releases` commercial feature. - name: custom-hooks x-displayName: Custom Hooks description: >- Sandboxed JavaScript validation hooks that run when features, configs, or their revisions are saved or published. Throwing an Error blocks the save; `addWarning(msg)` raises a soft warning. Hooks are scoped by projects, or pinned to a single feature/config via `entityType`/`entityId`; a config-scoped hook also runs for every config inheriting from it (its whole descendant lineage). Scope can be retargeted on update (or cleared with nulls). Requires an enterprise plan; not available on GrowthBook Cloud. - name: organizations x-displayName: Organizations description: >- Organizations are used for multi-org deployments where different teams can run their own isolated feature flags and experiments. These endpoints are only via a super-admin's Personal Access Token. - name: members x-displayName: Members description: Members are users who have been invited to an organization. - name: code-references x-displayName: Code References description: >- Intended for use with our code reference CI utility, [`gb-find-code-refs`](https://github.com/growthbook/gb-find-code-refs). - name: archetypes x-displayName: Archetypes description: >- Archetypes allow you to simulate the result of targeting rules on pre-set user attributes - name: queries x-displayName: Queries description: Retrieve queries used in experiments to calculate results. - name: settings x-displayName: Settings description: Get the organization settings. - name: attributes x-displayName: Attributes description: Used when targeting feature flags and experiments. - name: usage x-displayName: Usage description: Usage information for metrics in experiments. - name: meta x-displayName: Meta description: >- Server metadata, including the running build's version and commit for version-skew checks. - name: ContextualBandits x-displayName: Contextual Bandits description: '' - name: Dashboards x-displayName: Dashboards description: '' - name: ContextualBanditQueries x-displayName: Contextual Bandit Queries description: '' - name: CustomFields x-displayName: Custom Fields description: '' - name: MetricGroups x-displayName: Metric Groups description: '' - name: Teams x-displayName: Teams description: '' - name: ExperimentTemplates x-displayName: Experiment Templates description: '' - name: AnalyticsExplorations x-displayName: Analytics Explorations description: '' - name: RampScheduleTemplates x-displayName: Ramp Schedule Templates description: Reusable step configurations for ramp schedules. - name: Learnings x-displayName: Learnings description: >- Saved learnings captured across experiments, including AI-discovered patterns. - name: Holdouts x-displayName: Holdouts description: >- Hold a share of traffic out of all experiments to measure their combined effect. - name: AutoRuns x-displayName: Auto Runs description: '' - name: AggregatedFactTable_model x-displayName: Aggregated Fact Table description: - name: AnalyticsExploration_model x-displayName: Analytics Exploration description: - name: Archetype_model x-displayName: Archetype description: - name: Attribute_model x-displayName: Attribute description: - name: AutoRun_model x-displayName: Auto Run description: - name: CodeRef_model x-displayName: Code Ref description: - name: Config_model x-displayName: Config description: - name: ConfigKeyUsage_model x-displayName: Config Key Usage description: - name: ConfigLineage_model x-displayName: Config Lineage description: - name: ConfigReferences_model x-displayName: Config References description: - name: ConfigRevision_model x-displayName: Config Revision description: - name: ConfigRevisionActivityLogEntry_model x-displayName: Config Revision Activity Log Entry description: >- - name: ConfigRevisionRef_model x-displayName: Config Revision Ref description: - name: ConfigRevisionReview_model x-displayName: Config Revision Review description: - name: ConfigSchemaExport_model x-displayName: Config Schema Export description: - name: ConfigSchemaSource_model x-displayName: Config Schema Source description: - name: ConfigSchemaVerify_model x-displayName: Config Schema Verify description: - name: ConfigSchemaWarning_model x-displayName: Config Schema Warning description: - name: Constant_model x-displayName: Constant description: - name: ConstantReferences_model x-displayName: Constant References description: - name: ConstantRevision_model x-displayName: Constant Revision description: - name: ConstantRevisionActivityLogEntry_model x-displayName: Constant Revision Activity Log Entry description: >- - name: ConstantRevisionRef_model x-displayName: Constant Revision Ref description: - name: ConstantRevisionReview_model x-displayName: Constant Revision Review description: >- - name: ContextualBandit_model x-displayName: Contextual Bandit description: - name: ContextualBanditQuery_model x-displayName: Contextual Bandit Query description: >- - name: CustomField_model x-displayName: Custom Field description: - name: CustomHook_model x-displayName: Custom Hook description: - name: Dashboard_model x-displayName: Dashboard description: - name: DataSource_model x-displayName: Data Source description: - name: Dimension_model x-displayName: Dimension description: - name: Environment_model x-displayName: Environment description: - name: EventUser_model x-displayName: Event User description: - name: Experiment_model x-displayName: Experiment description: - name: Experiment Rule_model x-displayName: Experiment Rule description: - name: ExperimentAnalysisSettings_model x-displayName: Experiment Analysis Settings description: >- - name: ExperimentDecisionFrameworkSettings_model x-displayName: Experiment Decision Framework Settings description: >- - name: ExperimentMetric_model x-displayName: Experiment Metric description: - name: ExperimentMetricOverrideEntry_model x-displayName: Experiment Metric Override Entry description: >- - name: ExperimentResults_model x-displayName: Experiment Results description: - name: ExperimentSnapshot_model x-displayName: Experiment Snapshot description: - name: ExperimentTemplate_model x-displayName: Experiment Template description: - name: ExperimentWithEnhancedStatus_model x-displayName: Experiment With Enhanced Status description: >- - name: FactMetric_model x-displayName: Fact Metric description: - name: FactTable_model x-displayName: Fact Table description: - name: FactTableColumn_model x-displayName: Fact Table Column description: - name: FactTableFilter_model x-displayName: Fact Table Filter description: - name: FeatureBaseRule_model x-displayName: Feature Base Rule description: - name: FeatureContextualBanditRefRule_model x-displayName: Feature Contextual Bandit Ref Rule description: >- - name: FeatureDefinition_model x-displayName: Feature Definition description: - name: FeatureEnvironmentV1_model x-displayName: Feature Environment V1 description: - name: FeatureEnvironmentV2_model x-displayName: Feature Environment V2 description: - name: FeatureExperimentRefRule_model x-displayName: Feature Experiment Ref Rule description: >- - name: FeatureExperimentRule_model x-displayName: Feature Experiment Rule description: >- - name: FeatureForceRule_model x-displayName: Feature Force Rule description: - name: FeatureRevisionRef_model x-displayName: Feature Revision Ref description: - name: FeatureRevisionSummary_model x-displayName: Feature Revision Summary description: >- - name: FeatureRevisionV1_model x-displayName: Feature Revision V1 description: - name: FeatureRevisionV2_model x-displayName: Feature Revision V2 description: - name: FeatureRolloutRule_model x-displayName: Feature Rollout Rule description: - name: FeatureRuleV1_model x-displayName: Feature Rule V1 description: - name: FeatureRuleV2_model x-displayName: Feature Rule V2 description: - name: FeatureSafeRolloutRule_model x-displayName: Feature Safe Rollout Rule description: >- - name: FeatureV1_model x-displayName: Feature V1 description: - name: FeatureV2_model x-displayName: Feature V2 description: - name: FeatureWithRevisionsV1_model x-displayName: Feature With Revisions V1 description: >- - name: FeatureWithRevisionsV2_model x-displayName: Feature With Revisions V2 description: >- - name: Holdout_model x-displayName: Holdout description: - name: InformationSchema_model x-displayName: Information Schema description: - name: InformationSchemaTable_model x-displayName: Information Schema Table description: >- - name: Learning_model x-displayName: Learning description: - name: LookbackOverride_model x-displayName: Lookback Override description: - name: Member_model x-displayName: Member description: - name: Metric_model x-displayName: Metric description: - name: MetricAnalysis_model x-displayName: Metric Analysis description: - name: MetricGroup_model x-displayName: Metric Group description: - name: MetricUsage_model x-displayName: Metric Usage description: - name: Namespace_model x-displayName: Namespace description: - name: NamespaceExperimentMember_model x-displayName: Namespace Experiment Member description: >- - name: Organization_model x-displayName: Organization description: - name: PaginationFields_model x-displayName: Pagination Fields description: - name: Project_model x-displayName: Project description: - name: Query_model x-displayName: Query description: - name: RampSchedule_model x-displayName: Ramp Schedule description: - name: RampScheduleTemplate_model x-displayName: Ramp Schedule Template description: - name: Report_model x-displayName: Report description: - name: RequireReviewRule_model x-displayName: Require Review Rule description: - name: RequireReviewRuleInput_model x-displayName: Require Review Rule Input description: >- - name: RevisionIdRef_model x-displayName: Revision Id Ref description: - name: Safe Rollout Rule_model x-displayName: Safe Rollout Rule description: - name: SavedGroup_model x-displayName: Saved Group description: - name: SavedGroupApprovalRule_model x-displayName: Saved Group Approval Rule description: >- - name: SavedGroupReferenceResource_model x-displayName: Saved Group Reference Resource description: >- - name: SavedGroupReferences_model x-displayName: Saved Group References description: - name: SavedGroupRevision_model x-displayName: Saved Group Revision description: - name: SavedGroupRevisionActivityLogEntry_model x-displayName: Saved Group Revision Activity Log Entry description: >- - name: SavedGroupRevisionRef_model x-displayName: Saved Group Revision Ref description: >- - name: SavedGroupRevisionReview_model x-displayName: Saved Group Revision Review description: >- - name: ScheduleRule_model x-displayName: Schedule Rule description: - name: ScheduledStopPlan_model x-displayName: Scheduled Stop Plan description: - name: SdkConnection_model x-displayName: Sdk Connection description: - name: Segment_model x-displayName: Segment description: - name: Settings_model x-displayName: Settings description: - name: Targeting Rule_model x-displayName: Targeting Rule description: - name: TargetingReviewRule_model x-displayName: Targeting Review Rule description: - name: Team_model x-displayName: Team description: - name: VisualChange_model x-displayName: Visual Change description: - name: VisualChangeset_model x-displayName: Visual Changeset description: paths: /v1/features/{id}: post: tags: - features summary: Partially update a feature description: >- **Deprecated.** Use [POST /v2/features/:id](#operation/updateFeatureV2) instead. Updates the Feature Flag and immediately publishes a new revision. The caller needs Edit access in the Feature Flag's Project and Publish access for every affected environment. When approval is required, use the revision endpoints instead, unless the caller can bypass draft approvals. operationId: updateFeature parameters: - $ref: '#/components/parameters/id' requestBody: required: true content: application/json: schema: type: object properties: description: description: Description of the feature type: string maxLength: 10000 archived: type: boolean project: description: An associated project ID type: string targetingAllProjects: description: >- Make this feature discoverable in — and served to — every project, beyond its primary `project`. Requires the `targetFeatures` permission (FlagsTarget policy) unscoped to any project. Governance stays with `project`. type: boolean targetingProjects: description: >- Secondary project IDs this feature is targeted in and served to, beyond its primary `project`. Adding a project requires the `targetFeatures` permission (FlagsTarget policy) in that project. Governance stays with `project`. type: array items: type: string owner: description: >- The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization. type: string defaultValue: type: string baseConfig: description: >- The config backing this flag ("Config mode"), fixed at creation. Cannot be changed by an update — resend the current value or omit it; a different value (or null to detach) is rejected. anyOf: - type: string - type: 'null' tags: description: >- List of associated tags. Will override tags completely with submitted list type: array items: type: string environments: description: >- Settings for each environment, keyed by environment ID. Any environment you leave out keeps its current settings. type: object propertyNames: type: string additionalProperties: type: object properties: enabled: type: boolean rules: type: array items: anyOf: - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. description: type: string maxLength: 10000 condition: description: Applied to everyone by default. type: string savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' id: type: string enabled: description: Enabled by default type: boolean type: type: string const: force value: type: string sparse: description: >- JSON features only. When true, the rule value is a partial object merged onto the feature's default value instead of replacing it. type: boolean required: - type - value additionalProperties: false - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. description: type: string maxLength: 10000 condition: description: Applied to everyone by default. type: string savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' id: type: string enabled: description: Enabled by default type: boolean type: type: string const: rollout value: type: string sparse: description: >- JSON features only. When true, the rule value is a partial object merged onto the feature's default value instead of replacing it. type: boolean coverage: description: >- Percent of traffic included in this experiment. Users not included in the experiment will skip this rule. type: number hashAttribute: type: string seed: type: string hashVersion: description: >- Hash algorithm version for bucketing. Defaults to 2 (preferred) when not specified. anyOf: - type: number const: 1 - type: number const: 2 required: - type - value - coverage - hashAttribute additionalProperties: false - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. description: type: string maxLength: 10000 id: type: string enabled: description: Enabled by default type: boolean type: type: string const: experiment-ref condition: type: string savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' variations: type: array items: type: object properties: value: type: string variationId: type: string required: - value - variationId additionalProperties: false experimentId: type: string sparse: description: >- JSON features only. When true, the rule value is a partial object merged onto the feature's default value instead of replacing it. type: boolean required: - type - variations - experimentId additionalProperties: false - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false description: type: string maxLength: 10000 condition: type: string id: type: string enabled: description: Enabled by default type: boolean type: type: string const: experiment trackingKey: type: string hashAttribute: type: string fallbackAttribute: type: string disableStickyBucketing: type: boolean bucketVersion: type: number minBucketVersion: type: number namespace: type: object properties: enabled: type: boolean name: type: string range: minItems: 2 maxItems: 2 type: array items: type: number required: - enabled - name - range additionalProperties: false coverage: type: number prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' values: type: array items: type: object properties: value: type: string weight: type: number name: type: string required: - value - weight additionalProperties: false value: deprecated: true description: >- Support passing values under the value key as that was the original spec for FeatureExperimentRules type: array items: type: object properties: value: type: string weight: type: number name: type: string required: - value - weight additionalProperties: false experimentType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. hypothesis: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. hashVersion: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. datasource: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. exposureQueryId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. goalMetrics: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. secondaryMetrics: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. guardrailMetrics: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. activationMetric: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. segment: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. skipPartialData: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. regressionAdjustmentEnabled: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. sequentialTestingEnabled: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. sequentialTestingTuningParameter: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. statsEngine: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditStage: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditStageDateStarted: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditScheduleValue: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditScheduleUnit: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditBurnInValue: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditBurnInUnit: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditConversionWindowValue: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditConversionWindowUnit: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. templateId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. customFields: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. required: - condition - type additionalProperties: false definition: description: >- A JSON stringified [FeatureDefinition](#tag/FeatureDefinition_model) type: string draft: description: Use to write draft changes without publishing them. type: object properties: enabled: type: boolean rules: type: array items: anyOf: - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. description: type: string maxLength: 10000 condition: description: Applied to everyone by default. type: string savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' id: type: string enabled: description: Enabled by default type: boolean type: type: string const: force value: type: string sparse: description: >- JSON features only. When true, the rule value is a partial object merged onto the feature's default value instead of replacing it. type: boolean required: - type - value additionalProperties: false - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. description: type: string maxLength: 10000 condition: description: Applied to everyone by default. type: string savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' id: type: string enabled: description: Enabled by default type: boolean type: type: string const: rollout value: type: string sparse: description: >- JSON features only. When true, the rule value is a partial object merged onto the feature's default value instead of replacing it. type: boolean coverage: description: >- Percent of traffic included in this experiment. Users not included in the experiment will skip this rule. type: number hashAttribute: type: string seed: type: string hashVersion: description: >- Hash algorithm version for bucketing. Defaults to 2 (preferred) when not specified. anyOf: - type: number const: 1 - type: number const: 2 required: - type - value - coverage - hashAttribute additionalProperties: false - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. description: type: string maxLength: 10000 id: type: string enabled: description: Enabled by default type: boolean type: type: string const: experiment-ref condition: type: string savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' variations: type: array items: type: object properties: value: type: string variationId: type: string required: - value - variationId additionalProperties: false experimentId: type: string sparse: description: >- JSON features only. When true, the rule value is a partial object merged onto the feature's default value instead of replacing it. type: boolean required: - type - variations - experimentId additionalProperties: false - type: object properties: allProjects: description: >- When true (default), the rule applies to every project the feature is delivered to. When false, `projects` scopes it. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string rampScheduleId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. scheduleType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. savedGroups: type: array items: type: object properties: match: type: string enum: - all - none - any ids: type: array items: type: string required: - match - ids additionalProperties: false savedGroupTargeting: description: >- Deprecated — use `savedGroups`. Accepted so a GET response can be posted back unchanged; `savedGroups` takes precedence if both are sent. deprecated: true type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false description: type: string maxLength: 10000 condition: type: string id: type: string enabled: description: Enabled by default type: boolean type: type: string const: experiment trackingKey: type: string hashAttribute: type: string fallbackAttribute: type: string disableStickyBucketing: type: boolean bucketVersion: type: number minBucketVersion: type: number namespace: type: object properties: enabled: type: boolean name: type: string range: minItems: 2 maxItems: 2 type: array items: type: number required: - enabled - name - range additionalProperties: false coverage: type: number prerequisites: type: array items: type: object properties: id: description: Feature ID type: string condition: type: string required: - id - condition additionalProperties: false scheduleRules: type: array items: $ref: '#/components/schemas/ScheduleRule' values: type: array items: type: object properties: value: type: string weight: type: number name: type: string required: - value - weight additionalProperties: false value: deprecated: true description: >- Support passing values under the value key as that was the original spec for FeatureExperimentRules type: array items: type: object properties: value: type: string weight: type: number name: type: string required: - value - weight additionalProperties: false experimentType: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. hypothesis: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. hashVersion: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. datasource: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. exposureQueryId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. goalMetrics: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. secondaryMetrics: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. guardrailMetrics: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. activationMetric: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. segment: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. skipPartialData: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. regressionAdjustmentEnabled: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. sequentialTestingEnabled: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. sequentialTestingTuningParameter: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. statsEngine: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditStage: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditStageDateStarted: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditScheduleValue: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditScheduleUnit: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditBurnInValue: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditBurnInUnit: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditConversionWindowValue: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. banditConversionWindowUnit: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. templateId: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. customFields: description: >- Read-only; ignored on write. Accepted so a GET response can be posted back unchanged. required: - condition - type additionalProperties: false definition: description: >- A JSON stringified [FeatureDefinition](#tag/FeatureDefinition_model) type: string required: - rules additionalProperties: false required: - enabled - rules additionalProperties: false prerequisites: description: Feature IDs. Each feature must evaluate to `true` type: array items: type: string jsonSchema: description: >- Use JSON schema to validate the payload of a JSON-type feature value (enterprise only). type: string customFields: type: object propertyNames: type: string additionalProperties: type: string holdout: description: > Holdout to assign this feature to. Pass `null` to remove the feature from its current holdout. Omit the field entirely to leave the holdout unchanged. anyOf: - type: object properties: id: description: Holdout ID type: string value: description: >- The feature value assigned to users in the holdout treatment group type: string required: - id - value additionalProperties: false - type: 'null' comment: description: >- Comment to record on the revision this update publishes, when it publishes one. Defaults to "Created via REST API". type: string ignoreWarnings: description: >- Set to true to acknowledge the warnings listed in a blocked response and continue. This covers experiment guards, locked dependents, and references affected by an archive. When the organization treats schema failures as warnings, it also covers schema and invariant warnings. It never bypasses a rejected Custom Hook. On revision publish endpoints, it can also force-publish an out-of-date draft when the caller has Bypass draft approvals access. type: boolean skipSchemaValidation: description: >- Set to true to publish despite schema validation errors, failed invariants, or schema changes that invalidate dependent resources. This does not bypass a rejected Custom Hook; use `skipHooks` for that. The caller must have Bypass draft approvals access for Feature Flags, Configs, and Constants in every Project. Otherwise, this field is ignored. type: boolean skipHooks: description: >- Set to true to publish despite a Custom Hook rejection. This does not bypass schema validation; use `skipSchemaValidation` for that. The caller must have Bypass draft approvals access for Feature Flags, Configs, and Constants in every Project. Otherwise, this field is ignored. type: boolean additionalProperties: false responses: '200': description: Resource created content: application/json: schema: type: object properties: feature: $ref: '#/components/schemas/FeatureV1' bypassedGates: description: >- Gates that would have blocked this publish but were bypassed by the caller's authority. Present only when at least one gate was bypassed. type: array items: $ref: '#/components/schemas/bypassedGates' required: - feature additionalProperties: false deprecated: true x-codeSamples: - lang: cURL source: |- curl -X POST 'https://api.growthbook.io/api/v1/features/{id}' \ -H 'Authorization: Bearer YOUR_API_KEY' components: parameters: id: name: id in: path required: true description: The id of the requested resource schema: description: The id of the requested resource type: string schemas: ScheduleRule: type: object properties: enabled: description: >- Whether the rule should be enabled or disabled at the specified timestamp. type: boolean timestamp: description: ISO timestamp when the rule should activate. anyOf: - format: date-time type: string - type: 'null' required: - enabled - timestamp additionalProperties: false FeatureV1: type: object properties: id: type: string dateCreated: format: date-time type: string dateUpdated: format: date-time type: string archived: type: boolean description: type: string maxLength: 10000 owner: description: The userId of the owner (or raw owner name/email for legacy records) type: string ownerEmail: description: >- The email address of the owner, when the owner can be resolved to a known user. type: string project: type: string targetingAllProjects: type: boolean targetingProjects: type: array items: type: string valueType: type: string enum: - boolean - string - number - json defaultValue: type: string baseConfig: description: >- Key of the config backing this flag ("Config mode"), or null. The config supplies the base JSON and schema. The internal `@config:` directive is scrubbed from values; `@const:` references are preserved. (v2 additionally exposes per-rule config fields.) anyOf: - type: string - type: 'null' defaultValueConfig: description: >- Config within `baseConfig`'s family that the default value resolves to (a descendant), or null when the default uses `baseConfig` directly. anyOf: - type: string - type: 'null' tags: type: array items: type: string environments: type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/FeatureEnvironmentV1' prerequisites: description: Feature IDs. Each feature must evaluate to `true` type: array items: type: string revision: type: object properties: id: description: Stable id of the feature's live revision. type: string version: type: integer comment: type: string date: format: date-time type: string createdBy: type: string publishedBy: type: string required: - version - comment - date - createdBy - publishedBy additionalProperties: false customFields: type: object propertyNames: type: string additionalProperties: {} holdout: anyOf: - type: object properties: id: description: Holdout ID type: string value: description: >- The feature value assigned to users in the holdout treatment group type: string required: - id - value additionalProperties: false - type: 'null' required: - id - dateCreated - dateUpdated - archived - description - owner - project - valueType - defaultValue - tags - environments - revision additionalProperties: false bypassedGates: type: object properties: type: description: >- The gate that was bypassed (e.g. "approval-required", "stale-base", "schema-break"). type: string outcome: type: string const: bypassed via: description: >- How the gate was bypassed. The value identifies a request field (`ignoreWarnings`, `skipSchemaValidation`, or `skipHooks`), the caller's permission (`bypassApprovalPermission`), or an organization setting (`restApiBypassesReviews`, or `revertsBypassApproval` on a revert). type: string enum: - ignoreWarnings - skipSchemaValidation - skipHooks - bypassApprovalPermission - restApiBypassesReviews - revertsBypassApproval required: - type - outcome - via additionalProperties: false FeatureEnvironmentV1: type: object properties: enabled: type: boolean defaultValue: type: string rules: type: array items: $ref: '#/components/schemas/FeatureRuleV1' definition: description: A JSON stringified [FeatureDefinition](#tag/FeatureDefinition_model) type: string draft: type: object properties: enabled: type: boolean defaultValue: type: string rules: type: array items: $ref: '#/components/schemas/FeatureRuleV1' definition: description: >- A JSON stringified [FeatureDefinition](#tag/FeatureDefinition_model) type: string required: - enabled - defaultValue - rules additionalProperties: false required: - enabled - defaultValue - rules additionalProperties: false FeatureRuleV1: anyOf: - $ref: '#/components/schemas/FeatureForceRule' title: Feature Force Rule - $ref: '#/components/schemas/FeatureRolloutRule' title: Feature Rollout Rule - $ref: '#/components/schemas/FeatureExperimentRule' title: Feature Experiment Rule - $ref: '#/components/schemas/FeatureExperimentRefRule' title: Feature Experiment Ref Rule - $ref: '#/components/schemas/FeatureContextualBanditRefRule' title: Feature Contextual Bandit Ref Rule - $ref: '#/components/schemas/FeatureSafeRolloutRule' title: Feature Safe Rollout Rule FeatureForceRule: allOf: - description: > Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.). type: object properties: description: type: string maxLength: 10000 condition: type: string id: type: string enabled: type: boolean scheduleRules: description: Simple time-based on/off schedule for this rule type: array items: $ref: '#/components/schemas/ScheduleRule' scheduleType: description: > UI hint for which scheduling mode is active: - `none` – no schedule - `schedule` – simple time-based enable/disable via `scheduleRules` - `ramp` – multi-step ramp-up controlled by an associated RampSchedule document type: string enum: - none - schedule - ramp rampScheduleId: description: >- ID of the active RampSchedule document controlling this rule. Present when `scheduleType` is `ramp` and a live schedule exists. type: string savedGroupTargeting: type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID of the prerequisite type: string condition: type: string required: - id - condition additionalProperties: false allProjects: description: >- When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to `projects`. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string required: - description - id - enabled additionalProperties: false - type: object properties: type: type: string const: force value: type: string sparse: description: >- JSON features only. When true, `value` is a partial object merged onto the feature's default value instead of replacing it. type: boolean required: - type - value additionalProperties: false FeatureRolloutRule: allOf: - description: > Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.). type: object properties: description: type: string maxLength: 10000 condition: type: string id: type: string enabled: type: boolean scheduleRules: description: Simple time-based on/off schedule for this rule type: array items: $ref: '#/components/schemas/ScheduleRule' scheduleType: description: > UI hint for which scheduling mode is active: - `none` – no schedule - `schedule` – simple time-based enable/disable via `scheduleRules` - `ramp` – multi-step ramp-up controlled by an associated RampSchedule document type: string enum: - none - schedule - ramp rampScheduleId: description: >- ID of the active RampSchedule document controlling this rule. Present when `scheduleType` is `ramp` and a live schedule exists. type: string savedGroupTargeting: type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID of the prerequisite type: string condition: type: string required: - id - condition additionalProperties: false allProjects: description: >- When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to `projects`. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string required: - description - id - enabled additionalProperties: false - type: object properties: type: type: string const: rollout value: type: string sparse: description: >- JSON features only. When true, `value` is a partial object merged onto the feature's default value instead of replacing it. type: boolean coverage: type: number minimum: 0 maximum: 1 hashAttribute: type: string seed: description: Optional seed for the hash function; defaults to the rule id type: string hashVersion: description: >- Hash algorithm version for bucketing. Defaults to 2 (preferred) when not specified. anyOf: - type: number const: 1 - type: number const: 2 required: - type - value - coverage - hashAttribute additionalProperties: false FeatureExperimentRule: allOf: - description: > Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.). type: object properties: description: type: string maxLength: 10000 condition: type: string id: type: string enabled: type: boolean scheduleRules: description: Simple time-based on/off schedule for this rule type: array items: $ref: '#/components/schemas/ScheduleRule' scheduleType: description: > UI hint for which scheduling mode is active: - `none` – no schedule - `schedule` – simple time-based enable/disable via `scheduleRules` - `ramp` – multi-step ramp-up controlled by an associated RampSchedule document type: string enum: - none - schedule - ramp rampScheduleId: description: >- ID of the active RampSchedule document controlling this rule. Present when `scheduleType` is `ramp` and a live schedule exists. type: string savedGroupTargeting: type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID of the prerequisite type: string condition: type: string required: - id - condition additionalProperties: false allProjects: description: >- When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to `projects`. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string required: - description - id - enabled additionalProperties: false - type: object properties: type: type: string const: experiment trackingKey: type: string hashAttribute: type: string fallbackAttribute: type: string disableStickyBucketing: type: boolean bucketVersion: type: number minBucketVersion: type: number namespace: type: object properties: enabled: type: boolean name: type: string range: minItems: 2 maxItems: 2 type: array items: type: number required: - enabled - name - range additionalProperties: false coverage: type: number minimum: 0 maximum: 1 value: description: Variation values with weights type: array items: type: object properties: value: type: string weight: type: number name: type: string required: - value - weight additionalProperties: false required: - type additionalProperties: false FeatureExperimentRefRule: allOf: - description: > Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.). type: object properties: description: type: string maxLength: 10000 condition: type: string id: type: string enabled: type: boolean scheduleRules: description: Simple time-based on/off schedule for this rule type: array items: $ref: '#/components/schemas/ScheduleRule' scheduleType: description: > UI hint for which scheduling mode is active: - `none` – no schedule - `schedule` – simple time-based enable/disable via `scheduleRules` - `ramp` – multi-step ramp-up controlled by an associated RampSchedule document type: string enum: - none - schedule - ramp rampScheduleId: description: >- ID of the active RampSchedule document controlling this rule. Present when `scheduleType` is `ramp` and a live schedule exists. type: string savedGroupTargeting: type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID of the prerequisite type: string condition: type: string required: - id - condition additionalProperties: false allProjects: description: >- When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to `projects`. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string required: - description - id - enabled additionalProperties: false - type: object properties: type: type: string const: experiment-ref variations: type: array items: type: object properties: value: type: string variationId: type: string required: - value - variationId additionalProperties: false experimentId: type: string sparse: description: >- JSON features only. When true, each variation `value` is a partial object merged onto the feature's default value instead of replacing it. type: boolean required: - type - variations - experimentId additionalProperties: false FeatureContextualBanditRefRule: allOf: - description: > Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.). type: object properties: description: type: string maxLength: 10000 condition: type: string id: type: string enabled: type: boolean scheduleRules: description: Simple time-based on/off schedule for this rule type: array items: $ref: '#/components/schemas/ScheduleRule' scheduleType: description: > UI hint for which scheduling mode is active: - `none` – no schedule - `schedule` – simple time-based enable/disable via `scheduleRules` - `ramp` – multi-step ramp-up controlled by an associated RampSchedule document type: string enum: - none - schedule - ramp rampScheduleId: description: >- ID of the active RampSchedule document controlling this rule. Present when `scheduleType` is `ramp` and a live schedule exists. type: string savedGroupTargeting: type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID of the prerequisite type: string condition: type: string required: - id - condition additionalProperties: false allProjects: description: >- When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to `projects`. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string required: - description - id - enabled additionalProperties: false - type: object properties: type: type: string const: contextual-bandit-ref variations: type: array items: type: object properties: value: type: string variationId: type: string required: - value - variationId additionalProperties: false contextualBanditId: type: string required: - type - variations - contextualBanditId additionalProperties: false FeatureSafeRolloutRule: allOf: - description: > Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.). type: object properties: description: type: string maxLength: 10000 condition: type: string id: type: string enabled: type: boolean scheduleRules: description: Simple time-based on/off schedule for this rule type: array items: $ref: '#/components/schemas/ScheduleRule' scheduleType: description: > UI hint for which scheduling mode is active: - `none` – no schedule - `schedule` – simple time-based enable/disable via `scheduleRules` - `ramp` – multi-step ramp-up controlled by an associated RampSchedule document type: string enum: - none - schedule - ramp rampScheduleId: description: >- ID of the active RampSchedule document controlling this rule. Present when `scheduleType` is `ramp` and a live schedule exists. type: string savedGroupTargeting: type: array items: type: object properties: matchType: type: string enum: - all - any - none savedGroups: type: array items: type: string required: - matchType - savedGroups additionalProperties: false prerequisites: type: array items: type: object properties: id: description: Feature ID of the prerequisite type: string condition: type: string required: - id - condition additionalProperties: false allProjects: description: >- When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to `projects`. type: boolean projects: description: >- Project IDs this rule is scoped to when `allProjects` is false. An empty array scopes the rule to no project. type: array items: type: string required: - description - id - enabled additionalProperties: false - type: object properties: type: type: string const: safe-rollout controlValue: type: string variationValue: type: string seed: type: string hashAttribute: type: string trackingKey: type: string safeRolloutId: type: string status: type: string enum: - running - released - rolled-back - stopped required: - type - controlValue - variationValue additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: > If using Bearer auth, pass the Secret Key as the token: ```bash curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456" ``` basicAuth: type: http scheme: basic description: > If using HTTP Basic auth, pass the Secret Key as the username and leave the password blank: ```bash curl https://api.growthbook.io/api/v1/features -u secret_abc123DEF456: # The ":" at the end stops curl from asking for a password ``` ````