/launchdarkly-projects | Type: Application | PCID required: Yes
Tools
launchdarkly_projects_create_big_segment_export
Create big segment export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
launchdarkly_projects_create_big_segment_import
Create big segment import Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
file | string | No | — | CSV file containing keys |
mode | string | No | — | Import mode. Use either merge or replace |
waitOnApprovals | boolean | No | — | Whether to wait for approvals before processing the import |
launchdarkly_projects_create_layer
Create layer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
description | string | Yes | — | The checkout flow for the application |
key | string | Yes | — | Unique identifier for the layer |
name | string | Yes | — | Layer name |
launchdarkly_projects_delete_context_instances
Delete context instances Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The context instance ID |
launchdarkly_projects_delete_environment
Delete environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_projects_delete_project
Delete project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
launchdarkly_projects_delete_segment
Delete segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
launchdarkly_projects_evaluate_context_instance
Evaluate flags for context instance Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
limit | integer | No | — | The number of feature flags to return. Defaults to -1, which returns all flags |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
sort | string | No | — | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order |
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field operator value. Supported fields are explained above. |
body | object | Yes | — | Request body |
launchdarkly_projects_get_big_segment_export
Get big segment export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
exportID | string | Yes | — | The export ID |
launchdarkly_projects_get_big_segment_import
Get big segment import Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
importID | string | Yes | — | The import ID |
launchdarkly_projects_get_context_attribute_names
Get context attribute names Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
filter | string | No | — | A comma-separated list of context filters. This endpoint only accepts kind filters, with the equals operator, and name filters, with the startsWith operator. To learn more about the filter syntax, read Filtering contexts and context instances. |
limit | integer | No | — | Specifies the maximum number of items in the collection to return (max: 100, default: 100) |
launchdarkly_projects_get_context_attribute_values
Get context attribute values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
attributeName | string | Yes | — | The attribute name |
filter | string | No | — | A comma-separated list of context filters. This endpoint only accepts kind filters, with the equals operator, and value filters, with the startsWith operator. To learn more about the filter syntax, read Filtering contexts and context instances. |
limit | integer | No | — | Specifies the maximum number of items in the collection to return (max: 100, default: 50) |
launchdarkly_projects_get_context_instance_segments_membership_by_env
List segment memberships for context instance Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
body | object | Yes | — | Request body |
launchdarkly_projects_get_context_instances
Get context instances Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The context instance ID |
limit | integer | No | — | Specifies the maximum number of context instances to return (max: 50, default: 20) |
continuationToken | string | No | — | Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead. |
sort | string | No | — | Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts. |
filter | string | No | — | A comma-separated list of context filters. This endpoint only accepts an applicationId filter. To learn more about the filter syntax, read Filtering contexts and context instances. |
includeTotalCount | boolean | No | — | Specifies whether to include or omit the total count of matching context instances. Defaults to true. |
launchdarkly_projects_get_context_kinds_by_project_key
Get context kinds Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
launchdarkly_projects_get_contexts
Get contexts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
kind | string | Yes | — | The context kind |
key | string | Yes | — | The context key |
limit | integer | No | — | Specifies the maximum number of items in the collection to return (max: 50, default: 20) |
continuationToken | string | No | — | Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead. |
sort | string | No | — | Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts. |
filter | string | No | — | A comma-separated list of context filters. This endpoint only accepts an applicationId filter. To learn more about the filter syntax, read Filtering contexts and context instances. |
includeTotalCount | boolean | No | — | Specifies whether to include or omit the total count of matching contexts. Defaults to true. |
launchdarkly_projects_get_environment
Get environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_projects_get_environments_by_project
List environments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
limit | integer | No | — | The number of environments to return in the response. Defaults to 20. |
offset | integer | No | — | Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field:value. |
sort | string | No | — | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. |
launchdarkly_projects_get_expiring_targets_for_segment
Get expiring targets for segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
launchdarkly_projects_get_expiring_user_targets_for_segment
Get expiring user targets for segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
launchdarkly_projects_get_flag_defaults_by_project
Get flag defaults for project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
launchdarkly_projects_get_layers
Get layers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
filter | string | No | — | A comma-separated list of filters. This endpoint only accepts filtering by experimentKey. The filter returns layers which include that experiment for the selected environment(s). For example: filter=reservations.experimentKey contains expKey. |
launchdarkly_projects_get_project
Get project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key. |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. |
launchdarkly_projects_get_projects
List projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of projects to return in the response. Defaults to 20. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items. |
filter | string | No | — | A comma-separated list of filters. Each filter is constructed as field:value. |
sort | string | No | — | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. |
launchdarkly_projects_get_segment
Get segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
launchdarkly_projects_get_segment_membership_for_context
Get big segment membership for context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
contextKey | string | Yes | — | The context key |
launchdarkly_projects_get_segment_membership_for_user
Get big segment membership for user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
userKey | string | Yes | — | The user key |
launchdarkly_projects_get_segments
List segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
limit | integer | No | — | The number of segments to return. Defaults to 20. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
sort | string | No | — | Accepts sorting order and fields. Fields can be comma separated. Possible fields are ‘creationDate’, ‘name’, ‘lastModified’. Example: sort=name sort by names ascending or sort=-name,creationDate sort by names descending and creationDate ascending. |
filter | string | No | — | Accepts filter by excludedKeys, external, includedKeys, query, tags, unbounded, view. To learn more about the filter syntax, read the ‘Filtering segments’ section above. |
launchdarkly_projects_patch_environment
Update environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
body | object[] | Yes | — | Request body |
launchdarkly_projects_patch_expiring_targets_for_segment
Update expiring targets for segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
comment | string | No | — | Optional description of changes |
instructions | object[] | Yes | — | Semantic patch instructions for the desired changes to the resource |
launchdarkly_projects_patch_expiring_user_targets_for_segment
Update expiring user targets for segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
comment | string | No | — | Optional description of changes |
instructions | object[] | Yes | — | Semantic patch instructions for the desired changes to the resource |
launchdarkly_projects_patch_flag_defaults_by_project
Update flag default for project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
body | object[] | Yes | — | Request body |
launchdarkly_projects_patch_project
Update project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
body | object[] | Yes | — | Request body |
launchdarkly_projects_patch_segment
Patch segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
dryRun | boolean | No | — | If true, the patch will be validated but not persisted. Returns a preview of the segment after the patch is applied. |
comment | string | No | — | Optional comment |
patch | object[] | Yes | — | The patch value |
launchdarkly_projects_post_environment
Create environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
color | string | Yes | — | A color to indicate this environment in the UI |
confirmChanges | boolean | No | — | Requires confirmation for all flag and segment changes via the UI in this environment |
critical | boolean | No | — | Whether the environment is critical |
defaultTrackEvents | boolean | No | — | Enables tracking detailed information for new flags by default |
defaultTtl | integer | No | — | The default time (in minutes) that the PHP SDK can cache feature flag rules locally |
key | string | Yes | — | A project-unique key for the new environment |
name | string | Yes | — | A human-friendly name for the new environment |
requireComments | boolean | No | — | Requires comments for all flag and segment changes via the UI in this environment |
secureMode | boolean | No | — | Ensures that one end user of the client-side SDK cannot inspect the variations for another end user |
source | object | No | — | The source value |
tags | string[] | No | — | Tags to apply to the new environment |
launchdarkly_projects_post_project
Create project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
defaultClientSideAvailability | object | No | — | Default Client Side Availability |
environments | object[] | No | — | Creates the provided environments for this project. If omitted default environments will be created instead. |
includeInSnippetByDefault | boolean | No | — | Whether or not flags created in this project are made available to the client-side JavaScript SDK by default. |
key | string | Yes | — | A unique key used to reference the project in your code. |
name | string | Yes | — | A human-friendly name for the project. |
namingConvention | object | No | — | Naming Convention |
tags | string[] | No | — | Tags for the project |
launchdarkly_projects_post_segment
Create segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
description | string | No | — | A description of the segment’s purpose |
key | string | Yes | — | A unique key used to reference the segment |
name | string | Yes | — | A human-friendly name for the segment |
tags | string[] | No | — | Tags for the segment |
unbounded | boolean | No | — | Whether to create a standard segment (<code>false</code>) or a big segment (<code>true</code>). Standard segments include rule-based and smaller list-based segments. Big segments include larger list-based segments and synced segments. Only use a big segment if you need to add more than 15,000 individual targets. |
unboundedContextKind | string | No | — | For big segments, the targeted context kind. |
launchdarkly_projects_put_context_flag_setting
Update flag settings for context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
contextKind | string | Yes | — | The context kind |
contextKey | string | Yes | — | The context key |
featureFlagKey | string | Yes | — | The feature flag key |
comment | string | No | — | Optional comment describing the change |
setting | object | No | — | The variation value to set for the context. Must match the flag’s variation type. |
launchdarkly_projects_put_context_kind
Create or update context kind Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
key | string | Yes | — | The context kind key |
archived | boolean | No | — | Whether the context kind is archived. Archived context kinds are unavailable for targeting. |
description | string | No | — | The context kind description |
hideInTargeting | boolean | No | — | Alias for archived. |
name | string | Yes | — | The context kind name |
version | integer | No | — | The context kind version. If not specified when the context kind is created, defaults to 1. |
launchdarkly_projects_put_flag_defaults_by_project
Create or update flag defaults for project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
booleanDefaults | object | Yes | — | Boolean Defaults |
defaultClientSideAvailability | object | Yes | — | Default Client Side Availability |
tags | string[] | Yes | — | A list of default tags for each flag |
temporary | boolean | Yes | — | Whether the flag should be temporary by default |
launchdarkly_projects_reset_environment_mobile_key
Reset environment mobile SDK key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_projects_reset_environment_sdkkey
Reset environment SDK key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
expiry | integer | No | — | The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work. |
launchdarkly_projects_search_context_instances
Search for context instances Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
limit | integer | No | — | Specifies the maximum number of items in the collection to return (max: 50, default: 20) |
continuationToken | string | No | — | Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead. |
sort | string | No | — | Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts. |
filter | string | No | — | A comma-separated list of context filters. This endpoint only accepts an applicationId filter. To learn more about the filter syntax, read Filtering contexts and context instances. |
includeTotalCount | boolean | No | — | Specifies whether to include or omit the total count of matching context instances. Defaults to true. |
launchdarkly_projects_search_contexts
Search for contexts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
limit | integer | No | — | Specifies the maximum number of items in the collection to return (max: 50, default: 20) |
continuationToken | string | No | — | Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead. |
sort | string | No | — | Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts. |
filter | string | No | — | A comma-separated list of context filters. To learn more about the filter syntax, read Filtering contexts and context instances. |
includeTotalCount | boolean | No | — | Specifies whether to include or omit the total count of matching contexts. Defaults to true. |
launchdarkly_projects_update_big_segment_context_targets
Update context targets on a big segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
excluded | object | No | — | The excluded value |
included | object | No | — | The included value |
launchdarkly_projects_update_big_segment_targets
Update user context targets on a big segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
segmentKey | string | Yes | — | The segment key |
excluded | object | No | — | The excluded value |
included | object | No | — | The included value |
launchdarkly_projects_update_layer
Update layer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
layerKey | string | Yes | — | The layer key |
comment | string | No | — | Optional comment describing the update |
environmentKey | string | No | — | The environment key used for making environment specific updates. For example, updating the reservation of an experiment |
instructions | object[] | Yes | — | The instructions value |

