> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# launchdarkly-projects
> LaunchDarkly Projects — manage projects, environments, contexts, segments, and layers
**Server path:** `/launchdarkly-projects` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| [`launchdarkly_projects_create_big_segment_export`](#launchdarkly_projects_create_big_segment_export) | Create big segment export |
| [`launchdarkly_projects_create_big_segment_import`](#launchdarkly_projects_create_big_segment_import) | Create big segment import |
| [`launchdarkly_projects_create_layer`](#launchdarkly_projects_create_layer) | Create layer |
| [`launchdarkly_projects_delete_context_instances`](#launchdarkly_projects_delete_context_instances) | Delete context instances |
| [`launchdarkly_projects_delete_environment`](#launchdarkly_projects_delete_environment) | Delete environment |
| [`launchdarkly_projects_delete_project`](#launchdarkly_projects_delete_project) | Delete project |
| [`launchdarkly_projects_delete_segment`](#launchdarkly_projects_delete_segment) | Delete segment |
| [`launchdarkly_projects_evaluate_context_instance`](#launchdarkly_projects_evaluate_context_instance) | Evaluate flags for context instance |
| [`launchdarkly_projects_get_big_segment_export`](#launchdarkly_projects_get_big_segment_export) | Get big segment export |
| [`launchdarkly_projects_get_big_segment_import`](#launchdarkly_projects_get_big_segment_import) | Get big segment import |
| [`launchdarkly_projects_get_context_attribute_names`](#launchdarkly_projects_get_context_attribute_names) | Get context attribute names |
| [`launchdarkly_projects_get_context_attribute_values`](#launchdarkly_projects_get_context_attribute_values) | Get context attribute values |
| [`launchdarkly_projects_get_context_instance_segments_membership_by_env`](#launchdarkly_projects_get_context_instance_segments_membership_by_env) | List segment memberships for context instance |
| [`launchdarkly_projects_get_context_instances`](#launchdarkly_projects_get_context_instances) | Get context instances |
| [`launchdarkly_projects_get_context_kinds_by_project_key`](#launchdarkly_projects_get_context_kinds_by_project_key) | Get context kinds |
| [`launchdarkly_projects_get_contexts`](#launchdarkly_projects_get_contexts) | Get contexts |
| [`launchdarkly_projects_get_environment`](#launchdarkly_projects_get_environment) | Get environment |
| [`launchdarkly_projects_get_environments_by_project`](#launchdarkly_projects_get_environments_by_project) | List environments |
| [`launchdarkly_projects_get_expiring_targets_for_segment`](#launchdarkly_projects_get_expiring_targets_for_segment) | Get expiring targets for segment |
| [`launchdarkly_projects_get_expiring_user_targets_for_segment`](#launchdarkly_projects_get_expiring_user_targets_for_segment) | Get expiring user targets for segment |
| [`launchdarkly_projects_get_flag_defaults_by_project`](#launchdarkly_projects_get_flag_defaults_by_project) | Get flag defaults for project |
| [`launchdarkly_projects_get_layers`](#launchdarkly_projects_get_layers) | Get layers |
| [`launchdarkly_projects_get_project`](#launchdarkly_projects_get_project) | Get project |
| [`launchdarkly_projects_get_projects`](#launchdarkly_projects_get_projects) | List projects |
| [`launchdarkly_projects_get_segment`](#launchdarkly_projects_get_segment) | Get segment |
| [`launchdarkly_projects_get_segment_membership_for_context`](#launchdarkly_projects_get_segment_membership_for_context) | Get big segment membership for context |
| [`launchdarkly_projects_get_segment_membership_for_user`](#launchdarkly_projects_get_segment_membership_for_user) | Get big segment membership for user |
| [`launchdarkly_projects_get_segments`](#launchdarkly_projects_get_segments) | List segments |
| [`launchdarkly_projects_patch_environment`](#launchdarkly_projects_patch_environment) | Update environment |
| [`launchdarkly_projects_patch_expiring_targets_for_segment`](#launchdarkly_projects_patch_expiring_targets_for_segment) | Update expiring targets for segment |
| [`launchdarkly_projects_patch_expiring_user_targets_for_segment`](#launchdarkly_projects_patch_expiring_user_targets_for_segment) | Update expiring user targets for segment |
| [`launchdarkly_projects_patch_flag_defaults_by_project`](#launchdarkly_projects_patch_flag_defaults_by_project) | Update flag default for project |
| [`launchdarkly_projects_patch_project`](#launchdarkly_projects_patch_project) | Update project |
| [`launchdarkly_projects_patch_segment`](#launchdarkly_projects_patch_segment) | Patch segment |
| [`launchdarkly_projects_post_environment`](#launchdarkly_projects_post_environment) | Create environment |
| [`launchdarkly_projects_post_project`](#launchdarkly_projects_post_project) | Create project |
| [`launchdarkly_projects_post_segment`](#launchdarkly_projects_post_segment) | Create segment |
| [`launchdarkly_projects_put_context_flag_setting`](#launchdarkly_projects_put_context_flag_setting) | Update flag settings for context |
| [`launchdarkly_projects_put_context_kind`](#launchdarkly_projects_put_context_kind) | Create or update context kind |
| [`launchdarkly_projects_put_flag_defaults_by_project`](#launchdarkly_projects_put_flag_defaults_by_project) | Create or update flag defaults for project |
| [`launchdarkly_projects_reset_environment_mobile_key`](#launchdarkly_projects_reset_environment_mobile_key) | Reset environment mobile SDK key |
| [`launchdarkly_projects_reset_environment_sdkkey`](#launchdarkly_projects_reset_environment_sdkkey) | Reset environment SDK key |
| [`launchdarkly_projects_search_context_instances`](#launchdarkly_projects_search_context_instances) | Search for context instances |
| [`launchdarkly_projects_search_contexts`](#launchdarkly_projects_search_contexts) | Search for contexts |
| [`launchdarkly_projects_update_big_segment_context_targets`](#launchdarkly_projects_update_big_segment_context_targets) | Update context targets on a big segment |
| [`launchdarkly_projects_update_big_segment_targets`](#launchdarkly_projects_update_big_segment_targets) | Update user context targets on a big segment |
| [`launchdarkly_projects_update_layer`](#launchdarkly_projects_update_layer) | Update layer |
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"file": {
"type": "string",
"description": "CSV file containing keys"
},
"mode": {
"type": "string",
"description": "Import mode. Use either `merge` or `replace`"
},
"waitOnApprovals": {
"type": "boolean",
"description": "Whether to wait for approvals before processing the import"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"description": {
"type": "string",
"description": "The checkout flow for the application"
},
"key": {
"type": "string",
"description": "Unique identifier for the layer"
},
"name": {
"type": "string",
"description": "Layer name"
}
},
"required": [
"PCID",
"projectKey",
"description",
"key",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"id": {
"type": "string",
"description": "The context instance ID"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## launchdarkly\_projects\_delete\_project
Delete project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------- |
| `projectKey` | string | Yes | — | The project key |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
}
},
"required": [
"PCID",
"projectKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"limit": {
"type": "integer",
"description": "The number of feature flags to return. Defaults to -1, which returns all flags"
},
"offset": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order"
},
"filter": {
"type": "string",
"description": "A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above."
},
"body": {
"type": "object",
"description": "Request body"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"exportID": {
"type": "string",
"description": "The export ID"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"exportID"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"importID": {
"type": "string",
"description": "The import ID"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"importID"
]
}
```
***
## 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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). |
| `limit` | integer | No | — | Specifies the maximum number of items in the collection to return (max: 100, default: 100) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"filter": {
"type": "string",
"description": "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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances)."
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of items in the collection to return (max: 100, default: 100)"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). |
| `limit` | integer | No | — | Specifies the maximum number of items in the collection to return (max: 100, default: 50) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"attributeName": {
"type": "string",
"description": "The attribute name"
},
"filter": {
"type": "string",
"description": "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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances)."
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of items in the collection to return (max: 100, default: 50)"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"attributeName"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"body": {
"type": "object",
"description": "Request body"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). |
| `includeTotalCount` | boolean | No | — | Specifies whether to include or omit the total count of matching context instances. Defaults to true. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"id": {
"type": "string",
"description": "The context instance ID"
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of context instances to return (max: 50, default: 20)"
},
"continuationToken": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances)."
},
"includeTotalCount": {
"type": "boolean",
"description": "Specifies whether to include or omit the total count of matching context instances. Defaults to true."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"id"
]
}
```
***
## launchdarkly\_projects\_get\_context\_kinds\_by\_project\_key
Get context kinds
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------- |
| `projectKey` | string | Yes | — | The project key |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
}
},
"required": [
"PCID",
"projectKey"
]
}
```
***
## 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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). |
| `includeTotalCount` | boolean | No | — | Specifies whether to include or omit the total count of matching contexts. Defaults to true. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"kind": {
"type": "string",
"description": "The context kind"
},
"key": {
"type": "string",
"description": "The context key"
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of items in the collection to return (max: 50, default: 20)"
},
"continuationToken": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances)."
},
"includeTotalCount": {
"type": "boolean",
"description": "Specifies whether to include or omit the total count of matching contexts. Defaults to true."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"kind",
"key"
]
}
```
***
## launchdarkly\_projects\_get\_environment
Get environment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------- |
| `projectKey` | string | Yes | — | The project key |
| `environmentKey` | string | Yes | — | The environment key |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"limit": {
"type": "integer",
"description": "The number of environments to return in the response. Defaults to 20."
},
"offset": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "A comma-separated list of filters. Each filter is of the form `field:value`."
},
"sort": {
"type": "string",
"description": "A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order."
}
},
"required": [
"PCID",
"projectKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## launchdarkly\_projects\_get\_flag\_defaults\_by\_project
Get flag defaults for project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------- |
| `projectKey` | string | Yes | — | The project key |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
}
},
"required": [
"PCID",
"projectKey"
]
}
```
***
## 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"filter": {
"type": "string",
"description": "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`."
}
},
"required": [
"PCID",
"projectKey"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key."
},
"expand": {
"type": "string",
"description": "A comma-separated list of properties that can reveal additional information in the response."
}
},
"required": [
"PCID",
"projectKey"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "The number of projects to return in the response. Defaults to 20."
},
"offset": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "A comma-separated list of filters. Each filter is constructed as `field:value`."
},
"sort": {
"type": "string",
"description": "A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order."
},
"expand": {
"type": "string",
"description": "A comma-separated list of properties that can reveal additional information in the response."
}
},
"required": [
"PCID"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"contextKey": {
"type": "string",
"description": "The context key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"contextKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"userKey": {
"type": "string",
"description": "The user key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"userKey"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"limit": {
"type": "integer",
"description": "The number of segments to return. Defaults to 20."
},
"offset": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Accepts filter by `excludedKeys`, `external`, `includedKeys`, `query`, `tags`, `unbounded`, `view`. To learn more about the filter syntax, read the 'Filtering segments' section above."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "The type of operation to perform"
},
"path": {
"type": "string",
"description": "A JSON Pointer string specifying the part of the document to operate on"
},
"value": {
"description": "A JSON value used in \"add\", \"replace\", and \"test\" operations"
}
},
"required": [
"op",
"path"
]
},
"description": "Request body"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"comment": {
"type": "string",
"description": "Optional description of changes"
},
"instructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"addExpiringTarget",
"updateExpiringTarget",
"removeExpiringTarget"
],
"description": "The type of change to make to the context's removal date from this segment"
},
"contextKey": {
"type": "string",
"description": "A unique key used to represent the context"
},
"contextKind": {
"type": "string",
"description": "The kind of context"
},
"targetType": {
"type": "string",
"enum": [
"included",
"excluded"
],
"description": "The segment's target type"
},
"value": {
"type": "integer",
"format": "int64",
"description": "The time, in Unix milliseconds, when the context should be removed from this segment. Required if kind is addExpiringTarget or updateExpiringTarget."
},
"version": {
"type": "integer",
"description": "The version of the expiring target to update. Optional and only used if kind is updateExpiringTarget. If included, update will fail if version doesn't match current version of the expiring target."
}
},
"required": [
"kind",
"contextKey",
"contextKind",
"targetType"
]
},
"description": "Semantic patch instructions for the desired changes to the resource"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"instructions"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"comment": {
"type": "string",
"description": "Optional description of changes"
},
"instructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"addExpireUserTargetDate",
"updateExpireUserTargetDate",
"removeExpireUserTargetDate"
],
"description": "The type of change to make to the user's removal date from this segment"
},
"userKey": {
"type": "string",
"description": "A unique key used to represent the user"
},
"targetType": {
"type": "string",
"enum": [
"included",
"excluded"
],
"description": "The segment's target type"
},
"value": {
"type": "integer",
"description": "The time, in Unix milliseconds, when the user should be removed from this segment. Required if kind is addExpireUserTargetDate or updateExpireUserTargetDate."
},
"version": {
"type": "integer",
"description": "The version of the segment to update. Required if kind is updateExpireUserTargetDate."
}
},
"required": [
"kind",
"userKey",
"targetType"
]
},
"description": "Semantic patch instructions for the desired changes to the resource"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"instructions"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "The type of operation to perform"
},
"path": {
"type": "string",
"description": "A JSON Pointer string specifying the part of the document to operate on"
},
"value": {
"description": "A JSON value used in \"add\", \"replace\", and \"test\" operations"
}
},
"required": [
"op",
"path"
]
},
"description": "Request body"
}
},
"required": [
"PCID",
"projectKey",
"body"
]
}
```
***
## launchdarkly\_projects\_patch\_project
Update project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | --------------- |
| `projectKey` | string | Yes | — | The project key |
| `body` | object\[] | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "The type of operation to perform"
},
"path": {
"type": "string",
"description": "A JSON Pointer string specifying the part of the document to operate on"
},
"value": {
"description": "A JSON value used in \"add\", \"replace\", and \"test\" operations"
}
},
"required": [
"op",
"path"
]
},
"description": "Request body"
}
},
"required": [
"PCID",
"projectKey",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"dryRun": {
"type": "boolean",
"description": "If true, the patch will be validated but not persisted. Returns a preview of the segment after the patch is applied."
},
"comment": {
"type": "string",
"description": "Optional comment"
},
"patch": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "The type of operation to perform"
},
"path": {
"type": "string",
"description": "A JSON Pointer string specifying the part of the document to operate on"
},
"value": {
"description": "A JSON value used in \"add\", \"replace\", and \"test\" operations"
}
},
"required": [
"op",
"path"
]
},
"description": "The patch value"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey",
"patch"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"color": {
"type": "string",
"description": "A color to indicate this environment in the UI"
},
"confirmChanges": {
"type": "boolean",
"description": "Requires confirmation for all flag and segment changes via the UI in this environment"
},
"critical": {
"type": "boolean",
"description": "Whether the environment is critical"
},
"defaultTrackEvents": {
"type": "boolean",
"description": "Enables tracking detailed information for new flags by default"
},
"defaultTtl": {
"type": "integer",
"description": "The default time (in minutes) that the PHP SDK can cache feature flag rules locally"
},
"key": {
"type": "string",
"description": "A project-unique key for the new environment"
},
"name": {
"type": "string",
"description": "A human-friendly name for the new environment"
},
"requireComments": {
"type": "boolean",
"description": "Requires comments for all flag and segment changes via the UI in this environment"
},
"secureMode": {
"type": "boolean",
"description": "Ensures that one end user of the client-side SDK cannot inspect the variations for another end user"
},
"source": {
"type": "object",
"description": "The source value",
"properties": {
"key": {
"type": "string",
"description": "The key of the source environment to clone from"
},
"version": {
"type": "integer",
"description": "(Optional) The version number of the source environment to clone from. Used for optimistic locking"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply to the new environment"
}
},
"required": [
"PCID",
"projectKey",
"color",
"key",
"name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"defaultClientSideAvailability": {
"type": "object",
"description": "Default Client Side Availability",
"properties": {
"usingEnvironmentId": {
"type": "boolean",
"description": "Whether to enable availability for client-side SDKs."
},
"usingMobileKey": {
"type": "boolean",
"description": "Whether to enable availability for mobile SDKs."
}
},
"required": [
"usingEnvironmentId",
"usingMobileKey"
]
},
"environments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the new environment"
},
"key": {
"type": "string",
"description": "A project-unique key for the new environment"
},
"color": {
"type": "string",
"description": "A color to indicate this environment in the UI"
},
"defaultTtl": {
"type": "integer",
"description": "The default time (in minutes) that the PHP SDK can cache feature flag rules locally"
},
"secureMode": {
"type": "boolean",
"description": "Ensures that one end user of the client-side SDK cannot inspect the variations for another end user"
},
"defaultTrackEvents": {
"type": "boolean",
"description": "Enables tracking detailed information for new flags by default"
},
"confirmChanges": {
"type": "boolean",
"description": "Requires confirmation for all flag and segment changes via the UI in this environment"
},
"requireComments": {
"type": "boolean",
"description": "Requires comments for all flag and segment changes via the UI in this environment"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply to the new environment"
},
"source": {
"type": "object",
"description": "The source value"
},
"critical": {
"type": "boolean",
"description": "Whether the environment is critical"
}
},
"required": [
"name",
"key",
"color"
]
},
"description": "Creates the provided environments for this project. If omitted default environments will be created instead."
},
"includeInSnippetByDefault": {
"type": "boolean",
"description": "Whether or not flags created in this project are made available to the client-side JavaScript SDK by default."
},
"key": {
"type": "string",
"description": "A unique key used to reference the project in your code."
},
"name": {
"type": "string",
"description": "A human-friendly name for the project."
},
"namingConvention": {
"type": "object",
"description": "Naming Convention",
"properties": {
"case": {
"type": "string",
"description": "The casing convention to enforce for new flag keys in this project",
"enum": [
"camelCase",
"upperCamelCase",
"snakeCase",
"kebabCase",
"constantCase"
]
},
"prefix": {
"type": "string",
"description": "The prefix to enforce for new flag keys in this project"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags for the project"
}
},
"required": [
"PCID",
"key",
"name"
]
}
```
***
## 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 (\false\) or a big segment (\true\). 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"description": {
"type": "string",
"description": "A description of the segment's purpose"
},
"key": {
"type": "string",
"description": "A unique key used to reference the segment"
},
"name": {
"type": "string",
"description": "A human-friendly name for the segment"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags for the segment"
},
"unbounded": {
"type": "boolean",
"description": "Whether to create a standard segment (false) or a big segment (true). 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": {
"type": "string",
"description": "For big segments, the targeted context kind."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"key",
"name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"contextKind": {
"type": "string",
"description": "The context kind"
},
"contextKey": {
"type": "string",
"description": "The context key"
},
"featureFlagKey": {
"type": "string",
"description": "The feature flag key"
},
"comment": {
"type": "string",
"description": "Optional comment describing the change"
},
"setting": {
"description": "The variation value to set for the context. Must match the flag's variation type."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"contextKind",
"contextKey",
"featureFlagKey"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"key": {
"type": "string",
"description": "The context kind key"
},
"archived": {
"type": "boolean",
"description": "Whether the context kind is archived. Archived context kinds are unavailable for targeting."
},
"description": {
"type": "string",
"description": "The context kind description"
},
"hideInTargeting": {
"type": "boolean",
"description": "Alias for archived."
},
"name": {
"type": "string",
"description": "The context kind name"
},
"version": {
"type": "integer",
"description": "The context kind version. If not specified when the context kind is created, defaults to 1."
}
},
"required": [
"PCID",
"projectKey",
"key",
"name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"booleanDefaults": {
"type": "object",
"description": "Boolean Defaults",
"properties": {
"trueDisplayName": {
"type": "string",
"description": "The display name for the true variation, displayed in the LaunchDarkly user interface"
},
"falseDisplayName": {
"type": "string",
"description": "The display name for the false variation, displayed in the LaunchDarkly user interface"
},
"trueDescription": {
"type": "string",
"description": "The description for the true variation"
},
"falseDescription": {
"type": "string",
"description": "The description for the false variation"
},
"onVariation": {
"type": "integer",
"description": "The variation index of the flag variation to use for the default targeting behavior when a flag's targeting is on and the target did not match any rules"
},
"offVariation": {
"type": "integer",
"description": "The variation index of the flag variation to use for the default targeting behavior when a flag's targeting is off"
}
},
"required": [
"trueDisplayName",
"falseDisplayName",
"trueDescription",
"falseDescription",
"onVariation",
"offVariation"
]
},
"defaultClientSideAvailability": {
"type": "object",
"description": "Default Client Side Availability",
"properties": {
"usingMobileKey": {
"type": "boolean",
"description": "Whether to enable availability for mobile SDKs"
},
"usingEnvironmentId": {
"type": "boolean",
"description": "Whether to enable availability for client-side SDKs"
}
},
"required": [
"usingMobileKey",
"usingEnvironmentId"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of default tags for each flag"
},
"temporary": {
"type": "boolean",
"description": "Whether the flag should be temporary by default"
}
},
"required": [
"PCID",
"projectKey",
"booleanDefaults",
"defaultClientSideAvailability",
"tags",
"temporary"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"expiry": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). |
| `includeTotalCount` | boolean | No | — | Specifies whether to include or omit the total count of matching context instances. Defaults to true. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of items in the collection to return (max: 50, default: 20)"
},
"continuationToken": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances)."
},
"includeTotalCount": {
"type": "boolean",
"description": "Specifies whether to include or omit the total count of matching context instances. Defaults to true."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). |
| `includeTotalCount` | boolean | No | — | Specifies whether to include or omit the total count of matching contexts. Defaults to true. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of items in the collection to return (max: 50, default: 20)"
},
"continuationToken": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances)."
},
"includeTotalCount": {
"type": "boolean",
"description": "Specifies whether to include or omit the total count of matching contexts. Defaults to true."
}
},
"required": [
"PCID",
"projectKey",
"environmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"excluded": {
"type": "object",
"description": "The excluded value",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "The add value"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "The remove value"
}
}
},
"included": {
"type": "object",
"description": "The included value",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "The add value"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "The remove value"
}
}
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"description": "The environment key"
},
"segmentKey": {
"type": "string",
"description": "The segment key"
},
"excluded": {
"type": "object",
"description": "The excluded value",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "The add value"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "The remove value"
}
}
},
"included": {
"type": "object",
"description": "The included value",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "The add value"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "The remove value"
}
}
}
},
"required": [
"PCID",
"projectKey",
"environmentKey",
"segmentKey"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The project key"
},
"layerKey": {
"type": "string",
"description": "The layer key"
},
"comment": {
"type": "string",
"description": "Optional comment describing the update"
},
"environmentKey": {
"type": "string",
"description": "The environment key used for making environment specific updates. For example, updating the reservation of an experiment"
},
"instructions": {
"type": "array",
"items": {
"type": "object"
},
"description": "The instructions value"
}
},
"required": [
"PCID",
"projectKey",
"layerKey",
"instructions"
]
}
```