LaunchDarkly

List feature flags

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Get a list of all features in the given project.

Inputs

フィールド

種類

説明

projectKey [required]

string

The project key.

env

string

Filter configurations by environment. When specified, environments that do not match are omitted from the configuration of the feature flags.

limit

number

The number of feature flags to return. Defaults to -1, which returns all flags.

default: -1

filters

[string]

List of filters of the form field:value.

Outputs

Expand All

フィールド

種類

説明

items [required]

[object]

An array of feature flags

name [required]

string

A human-friendly name for the feature flag

kind [required]

enum

Kind of feature flag Allowed enum values: boolean,multivariate

description

string

Description of the feature flag

key [required]

string

A unique key used to reference the flag in your code

_version [required]

number

Version of the feature flag

creationDate [required]

number

includeInSnippet

boolean

DEPRECATED: Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK

clientSideAvailability

object

usingMobileKey

boolean

usingEnvironmentId

boolean

variations [required]

[object]

An array of possible variations for the flag

_id

string

The ID of the variation. Leave empty when you are creating a flag.

value [required]

The value of the variation. For boolean flags, this must be true or false. For multivariate flags, this may be a string, number, or JSON object.

description

string

Description of the variation. Defaults to an empty string, but is omitted from the response if not set.

name

string

A human-friendly name for the variation. Defaults to an empty string, but is omitted from the response if not set.

temporary [required]

boolean

Whether the flag is a temporary flag

tags [required]

[string]

Tags for the feature flag

_links [required]

object

The location and content type of related resources

maintainerId

string

Associated maintainerId for the feature flag

_maintainer

object

_links [required]

object

The location and content type of related resources

_id [required]

string

The member's ID

firstName

string

The member's first name

lastName

string

The member's last name

role [required]

string

The member's built-in role. If the member has no custom roles, this role will be in effect.

email [required]

string

The member's email address

maintainerTeamKey

string

The key of the associated team that maintains this feature flag

_maintainerTeam

object

key [required]

string

The key of the maintainer team

name [required]

string

A human-friendly name for the maintainer team

_links

object

The location and content type of related resources

goalIds

[string]

DEPRECATED: Deprecated, use experiments instead

experiments [required]

object

baselineIdx [required]

number

items [required]

[object]

metricKey

string

_metric

object

experimentCount

number

The number of experiments using this metric

metricGroupCount

number

The number of metric groups using this metric

_id [required]

string

The ID of this metric

_versionId [required]

string

The version ID of the metric

key [required]

string

A unique key to reference the metric

name [required]

string

A human-friendly name for the metric

kind [required]

enum

The kind of event the metric tracks Allowed enum values: pageview,click,custom

_attachedFlagCount

number

The number of feature flags currently attached to this metric

_links [required]

object

The location and content type of related resources

_site

object

href

string

type

string

_access

object

denied [required]

[object]

action [required]

string

reason [required]

object

resources

[string]

Resource specifier strings

notResources

[string]

Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field.

actions

[string]

Actions to perform on a resource

notActions

[string]

Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field.

effect [required]

enum

Whether this statement should allow or deny actions on the resources. Allowed enum values: allow,deny

role_name

string

allowed [required]

[object]

action [required]

string

reason [required]

object

resources

[string]

Resource specifier strings

notResources

[string]

Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field.

actions

[string]

Actions to perform on a resource

notActions

[string]

Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field.

effect [required]

enum

Whether this statement should allow or deny actions on the resources. Allowed enum values: allow,deny

role_name

string

tags [required]

[string]

Tags for the metric

_creationDate [required]

number

lastModified

object

date

string

maintainerId

string

The ID of the member who maintains this metric

_maintainer

object

_links [required]

object

The location and content type of related resources

_id [required]

string

The member's ID

firstName

string

The member's first name

lastName

string

The member's last name

role [required]

string

The member's built-in role. If the member has no custom roles, this role will be in effect.

email [required]

string

The member's email address

description

string

Description of the metric

isNumeric

boolean

For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false).

successCriteria

enum

For custom metrics, the success criteria Allowed enum values: HigherThanBaseline,LowerThanBaseline

unit

string

For numeric custom metrics, the unit of measure

eventKey

string

For custom metrics, the event key to use in your code

randomizationUnits

[string]

An array of randomization units allowed for this metric

unitAggregationType

enum

The method in which multiple unit event values are aggregated Allowed enum values: average,sum

analysisType

enum

The strategy for analyzing metric events Allowed enum values: mean,percentile

percentileValue

number

The percentile, an integer denoting the target percentile between 0 and 100. Only present when analysisType is percentile.

eventDefault

object

disabled

boolean

Whether to disable defaulting missing unit events when calculating results. Defaults to false

value

number

The default value applied to missing unit events. Only available when disabled is false. Defaults to 0

environments

[string]

_environmentSettings

object

customProperties [required]

object

archived [required]

boolean

Boolean indicating if the feature flag is archived

archivedDate

number

deprecated [required]

boolean

Boolean indicating if the feature flag is deprecated

variationJsonSchema

deprecatedDate

number

defaults

object

onVariation [required]

number

The index, from the array of variations for this flag, of the variation to serve by default when targeting is on.

offVariation [required]

number

The index, from the array of variations for this flag, of the variation to serve by default when targeting is off.

_purpose

string

migrationSettings

object

contextKind

string

The context kind targeted by this migration flag. Only applicable for six-stage migrations.

stageCount

number

The number of stages for this migration flag

environments [required]

object

Details on the environments for this flag

_links [required]

object

The location and content type of related resources

totalCount

number

The total number of flags

totalCountWithDifferences

number

The number of flags that have differences between environments. Only shown when query parameter compare is true.