release

Enable or disable a feature flag

Enables or disables a single feature flag for a release. The change is propagated to the app's connected feature flagging provider (LaunchDarkly, Statsig, or Optimizely) and recorded on the release timeline. Obtain flagId from GET /app/{appId}/release/{releaseId}/featureFlags. Read-only flags cannot be toggled and return a 400. Returns 404 when no flag matches flagId (including when the app has no feature flagging integration installed). Returns the updated feature flag on success.

put/app/{appId}/release/{releaseId}/featureFlag/{flagId}

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/release/{releaseId}/featureFlag/{flagId}
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

releaseIdstring required

The id of the release. Constructed from the app's id and the release version like so: {appId}:{version}. For the GET single release endpoint, the following keywords are also accepted: live (latest completed release), next or current (current active release).

flagIdstring required

The feature flag id to toggle (from GET /app/{appId}/release/{releaseId}/featureFlags).

Request body

enabledboolean required

Set to true to enable the flag or false to disable it. This field is required; omitting it returns a 400.

Response

The updated feature flag after being enabled or disabled

idstring

The feature flag's unique id. Use this with the toggle endpoint to enable or disable the flag.

namestring

The human-readable name of the feature flag.

descriptionstring nullable

An optional description of the feature flag.

createdAtstring date-time

When the flag was created.

updatedAtstring date-time nullable

When the flag was last updated.

enabledAtstring date-time nullable

When the flag was enabled, if applicable.

isEstimatedEnabledAtboolean

Whether enabledAt is an estimate rather than an exact timestamp.

estimatedDisabledAtstring date-time nullable

The estimated time the flag was disabled, if applicable.

minimumVersionstring nullable

The minimum app version the flag targets, if version-scoped.

maximumVersionstring nullable

The maximum app version the flag targets, if version-scoped.

equalVersionsstring[]

Specific app versions the flag targets.

rolloutPercentagenumber nullable

The percentage of users the flag is rolled out to, if applicable.

status'enabled' | 'disabled' | 'archived' | 'paused'

The current status of the flag.

type'featureFlagOptimizelyExperiment' | 'featureFlagOptimizelyFeature' | 'featureFlagOptimizelyFlag' | 'featureFlagLaunchDarklyFlag' | 'featureFlagStatsigGate' | 'featureFlagStatsigDynamicConfig' | 'featureFlagFirebaseRemoteConfigParam' | 'featureFlagFirebaseRemoteConfigBoolParam' | 'featureFlagAmplitudeExperimentFlag' | 'featureFlagAmplitudeExperimentExperiment' | 'featureFlagUnleashFeature'

The provider-specific type of the flag.

ownerstring nullable

The owner of the flag, if set in the provider.

platformsstring[]

The platforms the flag applies to.

urlstring nullable

A link to the flag in the provider's dashboard, if available.

isReadOnlyboolean

Whether the flag is read-only. Read-only flags cannot be enabled or disabled via the toggle endpoint.

isNewlyEnabledInThisVersionboolean

Whether the flag was newly enabled in this release version.

isNewlyDisabledInThisVersionboolean

Whether the flag was newly disabled in this release version.

isSpecificallyTargetingThisVersionboolean

Whether the flag specifically targets this release version.

isSpecificallyNotTargetingThisVersionboolean

Whether the flag specifically excludes this release version.

didChangeInThisVersionboolean

Whether the flag changed in this release version.

shouldHighlightboolean

Whether the UI should highlight this flag.

highlightTooltipTextstring

The tooltip text to show when the flag is highlighted.

Changes

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