LaunchDarkly integration: operations for AI agents
LaunchDarkly connects to Type.com as an integration. This page lists the 382 operations documented for Claude and Codex in Type.com: 190 read, 132 write, 60 destructive.
About LaunchDarkly
A feature management platform that helps teams build better software faster using feature flags.
Categories: Developer Tools & IT
How to connect LaunchDarkly to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
382 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
382 operations listed.
Other
- Read
Root resource
Get all of the resource categories the API supports. In the sandbox, click 'Play' and enter any string in the 'Authorization' field to test this endpoint.
- Read
Identify the caller
Get basic information about the identity used (session cookie, API token, SDK keys, etc.) to call the API
- Read
Gets the OpenAPI spec in json
Get the latest version of the OpenAPI specification for LaunchDarkly's API in JSON format. In the sandbox, click 'Play' and enter any string in the 'Authorization' field to test this endpoint.
- Read
Gets the public IP list
Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. We post upcoming changes to this list in advance on our status page.
- Read
Get version information
Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format.
Relay Proxy configurations
- Read
List Relay Proxy configs
Get a list of Relay Proxy configurations in the account.
- Read
Get Relay Proxy config
Get a single Relay Proxy auto config by ID.
- Write
Create a new Relay Proxy config
Create a Relay Proxy config.
- Write
Update a Relay Proxy config
Update a Relay Proxy configuration. Updating a configuration uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.
- Write
Reset Relay Proxy configuration key
Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.
- Destructive
Delete Relay Proxy config by ID
Delete a Relay Proxy config.
Applications (beta)
- Read
Get applications
Get a list of applications. Expanding the applications response LaunchDarkly supports expanding the "Get applications" response to include additional fields.
- Read
Get application by key
Retrieve an application by the application key. Expanding the application response LaunchDarkly supports expanding the "Get application" response to include additional fields.
- Read
Get application versions by application key
Get a list of versions for a specific application in an account.
- Write
Update application
Update an application. You can update the description and kind fields. Requires a JSON patch representation of the desired changes to the application. To learn more, read Updates.
- Write
Update application version
Update an application version. You can update the supported field. Requires a JSON patch representation of the desired changes to the application version. To learn more, read Updates.
- Destructive
Delete application
Delete an application.
- Destructive
Delete application version
Delete an application version.
Approvals
- Read
List approval requests
Get all approval requests. Filtering approvals LaunchDarkly supports the filter query param for filtering, with the following fields: - notifyMemberIds filters for only approvals that are assigned to a member in the specified list.
- Read
Get approval request
Get an approval request by approval request ID. Expanding approval response LaunchDarkly supports the expand query param to include additional fields in the response, with the following fields: - environments includes the environments the approval request relates to - flag inclu…
- Read
List approval requests for a flag
Get all approval requests for a feature flag.
- Read
Get approval request for a flag
Get a single approval request for a feature flag.
- Write
Create approval request
Create an approval request. This endpoint requires a list of instructions, in semantic patch format, that will be applied when the approval request is approved and applied.
- Write
Apply approval request
Apply an approval request that has been approved. This endpoint works with any approval requests.
- Write
Review approval request
Review an approval request by approving or denying changes.
- Write
Create approval request for a flag
Create an approval request for a feature flag.
- Write
Create approval request to copy flag configurations across environments
Create an approval request to copy a feature flag's configuration across environments.
- Write
Apply approval request for a flag
Apply an approval request that has been approved. This endpoint requires a feature flag key, and can only be used for applying approval requests on flags.
- Write
Review approval request for a flag
Review an approval request by approving or denying changes.
- Destructive
Delete approval request
Delete an approval request.
- Destructive
Delete approval request for a flag
Delete an approval request for a feature flag.
Approvals (beta)
- Read
Get approval request settings
Get the approval request settings for the given project, optionally filtered by environment and resource kind.
- Write
Update approval request
Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with any approval requests. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header.
- Write
Update flag approval request
Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags.
- Write
Update approval request settings
Perform a partial update to approval request settings
Audit log
- Read
List audit log entries
Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources.
- Read
Search audit log entries
Search your audit log entries. The query parameters let you restrict the results that return by date ranges, or a full-text search query. The request body lets you restrict the results that return by resource specifiers.
- Read
Get audit log entry counts
Returns aggregate counts of audit log entries per time bucket. Used for dashboard overlays that show flag targeting changes.
- Read
Get audit log entry
Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - previousVersion: a JSON representation of the previous version of the entity.
Code references
- Read
List extinctions
Get a list of all extinctions. LaunchDarkly creates an extinction event after you remove all code references to a flag. To learn more, read About extinction events.
- Read
List repositories
Get a list of connected repositories. Optionally, you can include branch metadata with the withBranches query parameter. Embed references for the default branch with ReferencesForDefaultBranch. You can also filter the list of code references by project key and flag key.
- Read
Get repository
Get a single repository by name.
- Read
List branches
Get a list of branches.
- Read
Get branch
Get a specific branch in a repository.
- Read
Get links to code reference repositories for each project
Get links for all projects that have code references.
- Read
Get code references statistics for flags
Get statistics about all the code references across repositories for all flags in your project that have code references in the default branch, for example, main.
- Write
Create repository
Create a repository with the specified name.
- Write
Update repository
Update a repository's settings. Updating repository settings uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.
- Write
Create extinction
Create a new extinction.
- Destructive
Delete repository
Delete a repository with the specified name.
- Destructive
Delete branches
Asynchronously delete a number of branches.
- Destructive
Upsert branch
Create a new branch if it doesn't exist, or update the branch if it already exists.
Data Export destinations
- Read
List destinations
Get a list of Data Export destinations configured across all projects and environments.
- Read
Get destination
Get a single Data Export destination by ID. The destination must belong to the environment in the URL. Otherwise, the response is 404.
- Write
Generate Snowflake destination key pair
Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination
- Write
Generate trust policy
Trust policy to allow Data Export to assume the role and perform operations on AWS resources
- Write
Generate Snowflake destination key pair
Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination
- Write
Complete warehouse destination setup
Complete the setup of a warehouse destination by providing the Snowflake host address and the public keys from the /setup response. The custom names are read from the stored configuration.
- Write
Generate warehouse destination setup script
Generate the SQL setup script required to prepare a warehouse for LaunchDarkly Data Export. For Snowflake, this also generates a key pair. Custom Snowflake object names may be provided. If omitted, defaults are used.
- Write
Create Data Export destination
Create a new Data Export destination. In the config request body parameter, the fields required depend on the type of Data Export destination.
- Write
Update Data Export destination
Update a Data Export destination. The destination must belong to the environment in the URL. Otherwise, the response is 404. Updating a destination uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete Data Export destination
Delete a Data Export destination by ID. The destination must belong to the environment in the URL. Otherwise, the response is 404.
Flag links (beta)
- Read
List flag links
Get a list of all flag links.
- Write
Create flag link
Create a new flag link. Flag links let you reference external resources and associate them with your flags.
- Write
Update flag link
Update a flag link. Updating a flag link uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete flag link
Delete a flag link by ID or key.
Feature flags
- Read
Get flag status across environments
Get the status for a particular feature flag across environments.
- Read
List feature flag statuses
Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - new: You created the flag fewer than seven days ago and it has never been requested.
- Read
Get feature flag status
Get the status for a particular feature flag.
- Read
List feature flags
Get a list of all feature flags in the given project. You can include information specific to different environments by adding env query parameter. For example, setting env=production adds configuration details about your production environment to the response.
- Read
Get feature flag
Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the env query parameter. For example, setting env=production restricts the returned configurations to just the production environment.
- Read
Get expiring context targets for feature flag
Get a list of context targets on a feature flag that are scheduled for removal.
- Read
Get expiring user targets for feature flag
Contexts are now available After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Get expiring context targets for feature flag instead of this endpoint. To learn more, read Contexts.
- Read
Get migration safety issues
Returns the migration safety issues that are associated with the POSTed flag patch. The patch must use the semantic patch format for updating feature flags.
- Write
Create a feature flag
Create a feature flag with the given name, key, and variations. Click to expand instructions for creating a migration flag Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration.
- Write
Update feature flag
Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read Updates.
- Write
Copy feature flag
Copying flag settings is an Enterprise feature Copying flag settings is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales. Copy flag settings from a source environment to a target environment.
- Write
Update expiring context targets on feature flag
Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context. You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag.
- Write
Update expiring user targets on feature flag
Contexts are now available After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Update expiring context targets on feature flag instead of this endpoint. To learn more, read Contexts.
- Destructive
Delete feature flag
Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
Feature flags (beta)
- Read
List dependent feature flags by environment
Flag prerequisites is an Enterprise feature Flag prerequisites is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales. List dependent flags across all environments for the flag specified in the path parameters.
- Read
List dependent feature flags
Flag prerequisites is an Enterprise feature Flag prerequisites is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales. List dependent flags across all environments for the flag specified in the path parameters.
Flag triggers
- Read
List flag triggers
Get a list of all flag triggers.
- Read
Get flag trigger by ID
Get a flag trigger by ID.
- Write
Create flag trigger
Create a new flag trigger.
- Write
Update flag trigger
Update a flag trigger. Updating a flag trigger uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.
- Destructive
Delete flag trigger
Delete a flag trigger by ID.
Persistent store integrations (beta)
- Read
List all big segment store integrations
List all big segment store integrations.
- Read
Get big segment store integration by ID
Get a big segment store integration by ID.
- Write
Create big segment store integration
Create a persistent store integration. If you are using server-side SDKs, segments synced from external tools and larger list-based segments require a persistent store within your infrastructure.
- Write
Update big segment store integration
Update a big segment store integration. Updating a big segment store requires a JSON Patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete big segment store integration
Delete a persistent store integration. Each integration uses either Redis or DynamoDB.
Integration delivery configurations (beta)
- Read
List all delivery configurations
List all delivery configurations.
- Read
Get delivery configurations by environment
Get delivery configurations by environment.
- Read
Get delivery configuration by ID
Get delivery configuration by ID.
- Read
Validate delivery configuration
Validate the saved delivery configuration, using the validationRequest in the integration's manifest.json file.
- Write
Create delivery configuration
Create a delivery configuration.
- Write
Update delivery configuration
Update an integration delivery configuration. Updating an integration delivery configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete delivery configuration
Delete a delivery configuration.
Flag import configurations (beta)
- Read
List all flag import configurations
List all flag import configurations.
- Read
Get a single flag import configuration
Get a single flag import configuration by ID. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.
- Write
Create a flag import configuration
Create a new flag import configuration. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.
- Write
Update a flag import configuration
Updating a flag import configuration uses a JSON patch representation of the desired changes. To learn more, read Updates. To add an element to the import configuration fields that are arrays, set the path to the name of the field and then append / .
- Write
Trigger a single flag import run
Trigger a single flag import run for an existing flag import configuration. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.
- Destructive
Delete a flag import configuration
Delete a flag import configuration by ID. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.
Integrations (beta)
- Read
Get all configurations for the integration
Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations.).
- Read
Get an integration configuration
Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)
- Write
Create integration configuration
Create a new integration configuration. (Excludes persistent store and flag import configurations.)
- Write
Update integration configuration
Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete integration configuration
Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)
Integration audit log subscriptions
- Read
Get audit log subscriptions by integration
Get all audit log subscriptions associated with a given integration.
- Read
Get audit log subscription by ID
Get an audit log subscription by ID.
- Write
Create audit log subscription
Create an audit log subscription. For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read Custom role concepts.
- Write
Update audit log subscription
Update an audit log subscription configuration. Updating an audit log subscription uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete audit log subscription
Delete an audit log subscription.
Account members
- Read
List account members
Return a list of account members. By default, this returns the first 20 members. Page through this list with the limit parameter and by following the first, prev, next, and last links in the returned links field. These links are not present if the pages they refer to don't exist.
- Read
Get account member
Get a single account member by member ID. me is a reserved value for the id parameter that returns the caller's member information. Expanding the member response LaunchDarkly supports the following fields for expanding the "Get member" response.
- Write
Invite new members
Invite one or more new members to join an account. Each member is sent an invitation. Members with Admin or Owner roles may create new members, as well as anyone with a createMember permission for "member/\".
- Write
Modify account members
Full use of this API resource is an Enterprise feature The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, read about our pricing.
- Write
Modify an account member
Update a single account member. Updating a member uses a JSON patch representation of the desired changes. To learn more, read Updates. To update fields in the account member object that are arrays, set the path to the name of the field and then append / .
- Write
Add a member to teams
Add one member to one or more teams.
- Destructive
Delete account member
Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
Metrics
- Read
List metrics
Get a list of all metrics for the specified project. Filtering metrics The filter parameter supports the following operators: contains, equals, anyOf. Supported fields and operators You can only filter certain fields in metrics when using the filter parameter.
- Read
Get metric
Get information for a single metric from the specific project. Expanding the metric response LaunchDarkly supports four fields for expanding the "Get metric" response. By default, these fields are not included in the response.
- Write
Create metric
Create a new metric in the specified project. The expected POST body differs depending on the specified kind property.
- Write
Update metric
Patch a metric by key. Updating a metric uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete metric
Delete a metric by key.
OAuth2 Clients
- Read
Get clients
Get all OAuth 2.0 clients registered by your account.
- Read
Get client by ID
Get a registered OAuth 2.0 client by unique client ID.
- Write
Create a LaunchDarkly OAuth 2.0 client
Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider.
- Write
Patch client by ID
Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a JSON patch representation of the desired changes. To learn more, read Updates. Only name, description, and redirectUri may be patched.
- Destructive
Delete OAuth 2.0 client
Delete an existing OAuth 2.0 client by unique client ID.
Projects
- Read
List projects
Return a list of projects. By default, this returns the first 20 projects. Page through this list with the limit parameter and by following the first, prev, next, and last links in the links field that returns. If those links do not appear, the pages they refer to don't exist.
- Read
Get project
Get a single project by key. Expanding the project response LaunchDarkly supports one field for expanding the "Get project" response. By default, these fields are not included in the response.
- Read
Get flag defaults for project
Get the flag defaults for a specific project.
- Write
Create project
Create a new project with the given key and name. Project keys must be unique within an account.
- Write
Update project
Update a project. Updating a project uses a JSON patch representation of the desired changes. To learn more, read Updates. To add an element to the project fields that are arrays, set the path to the name of the field and then append / .
- Write
Update flag default for project
Update a flag default. Updating a flag default uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete project
Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
- Destructive
Create or update flag defaults for project
Create or update flag defaults for a project.
Contexts
- Read
Get context kinds
Get all context kinds for a given project.
- Read
Get context attribute names
Get context attribute names.
- Read
Get context attribute values
Get context attribute values.
- Read
Search for contexts
Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. Results are sorted by context kind and key. Each context appears once, with its most recently reported attributes.
- Read
Get contexts
Get contexts based on kind and key. Returns one item for each application from which LaunchDarkly has received the context, with the applicationId field populated.
- Write
Evaluate flags for context instance
Evaluate flags for a context instance, for example, to determine the expected flag variation. Do not use this API instead of an SDK.
- Destructive
Create or update context kind
Create or update a context kind by key. Only the included fields will be updated.
Environments
- Read
List environments
Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the limit parameter and by following the first, prev, next, and last links in the links field that returns.
- Read
Get environment
Approval settings The approvalSettings and resourceApprovalSettings keys are only returned when the approvals feature is enabled. Get an environment given a project and key.
- Write
Create environment
Approval settings You cannot configure approval settings when you create a new environment. Use Update environment to update approval settings. The approvalSettings and resourceApprovalSettings keys are only returned when the approvals feature is enabled.
- Write
Update environment
Update an environment. Updating an environment uses a JSON patch representation of the desired changes. To learn more, read Updates. To update fields in the environment object that are arrays, set the path to the name of the field and then append / .
- Write
Reset environment SDK key
Reset an environment's SDK key with an optional expiry time for the old key.
- Write
Reset environment mobile SDK key
Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
- Destructive
Delete environment
Delete a environment by key.
Context settings
- Destructive
Update flag settings for context
Enable or disable a feature flag for a context based on its context kind and key. In the request body, the setting should be the variation value to set for the context. It must match the flag's variation type.
Experiments
- Read
Get experiments
Get details about all experiments in an environment. Filtering experiments LaunchDarkly supports the filter query param for filtering, with the following fields: - flagKey filters for only experiments that use the flag with the given key.
- Read
Get experiment
Get details about an experiment. Expanding the experiment response LaunchDarkly supports five fields for expanding the "Get experiment" response. By default, these fields are not included in the response.
- Read
Get experimentation settings
Get current experimentation settings for the given project
- Read
Get experiments any environment
Get a list of experiments from across all environments in the project
- Write
Create experiment
Create an experiment. To run this experiment, you'll need to create an iteration and then update the experiment with the startIteration instruction. Experiment types Use the type field to specify the experiment type: experiment (default), mab (multi-armed bandit), or holdout.
- Write
Patch experiment
Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.
- Destructive
Update experimentation settings
Update experimentation settings for the given project
Follow flags
- Read
Get followers of all flags in a given project and environment
Get followers of all flags in a given environment and project
- Read
Get followers of a flag in a project and environment
Get a list of members following a flag in a project and environment
- Destructive
Add a member as a follower of a flag in a project and environment
Add a member as a follower to a flag in a project and environment
- Destructive
Remove a member as a follower of a flag in a project and environment
Remove a member as a follower to a flag in a project and environment
Holdouts
- Read
Get all holdouts
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
- Read
Get Holdout by Id
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}
- Read
Get holdout
Get details about a holdout. Expanding the holdout response LaunchDarkly supports the following fields for expanding the "Get holdout" response. By default, these fields are not included in the response.
- Write
Create holdout
Create a new holdout in the specified project.
- Write
Patch holdout
Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.
Segments
- Read
List segment memberships for context instance
For a given context instance with attributes, get membership details for all segments. In the request body, pass in the context instance.
- Read
List segments
Get a list of all segments in the given project. Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments.
- Read
Get segment
Get a single segment by key. Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments.
- Read
Get big segment membership for context
Get the membership status (included/excluded) for a given context in this big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments.
- Read
Get big segment export
Returns information about a big segment export process. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries.
- Read
Get big segment import
Returns information about a big segment import process. This is the import of a list-based segment that can include more than 15,000 entries.
- Read
Get big segment membership for user
Contexts are now available After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Get expiring targets for segment instead of this endpoint. To learn more, read Contexts.
- Read
Get expiring targets for segment
Get a list of a segment's context targets that are scheduled for removal.
- Read
Get expiring user targets for segment
Contexts are now available After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Get expiring targets for segment instead of this endpoint. To learn more, read Contexts.
- Write
Create segment
Create a new segment. The new segment has no individual targets or rules. The request body only accepts the fields documented below.
- Write
Patch segment
Update a segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read Updates.
- Write
Update context targets on a big segment
Update context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments.
- Write
Create big segment export
Starts a new export process for a big segment. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries.
- Write
Create big segment import
Start a new import process for a big segment. This is an import for a list-based segment that can include more than 15,000 entries.
- Write
Update user context targets on a big segment
Update user context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments.
- Write
Update expiring targets for segment
Update expiring context targets for a segment. Updating a context target expiration uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header.
- Write
Update expiring user targets for segment
Contexts are now available After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Update expiring targets for segment instead of this endpoint. To learn more, read Contexts. Update expiring user targets for a segment.
- Destructive
Delete segment
Delete a segment.
Scheduled changes
- Read
List scheduled changes
Get a list of scheduled changes that will be applied to the feature flag.
- Read
Get a scheduled change
Get a scheduled change that will be applied to the feature flag by ID.
- Write
Create scheduled changes workflow
Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when updating a feature flag.
- Write
Update scheduled changes workflow
Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header.
- Destructive
Delete scheduled changes workflow
Delete a scheduled changes workflow.
Workflows
- Read
Get workflows
Display workflows associated with a feature flag.
- Read
Get custom workflow
Get a specific workflow by ID.
- Write
Create workflow
Workflows are in maintenance mode The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. We will work with existing customers using workflows to migrate to a replacement solution when deprecation occurs.
- Destructive
Delete workflow
Delete a workflow from a feature flag.
Layers
- Read
Get layers
Get a collection of all layers for a project
- Write
Create layer
Create a layer. Experiments running in the same layer are granted mutually-exclusive traffic.
- Write
Update layer
Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format.
Metrics (beta)
- Read
List metric groups
Get a list of all metric groups for the specified project. Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an expand query parameter for compatibility reasons, it does not currently modify the response.
- Read
Get metric group
Get information for a single metric group from the specific project. Expanding the metric group response LaunchDarkly supports two fields for expanding the "Get metric group" response. By default, these fields are not included in the response.
- Write
Create metric group
Create a new metric group in the specified project
- Write
Patch metric group
Patch a metric group by key. Updating a metric group uses a JSON patch representation of the desired changes.
- Destructive
Delete metric group
Delete a metric group by key.
Custom roles
- Read
List custom roles
Get a complete list of custom roles. This includes project and organization roles that you create, or that are provided as presets by LaunchDarkly. It does not include base roles.
- Read
Get custom role
Get a single custom role by key or ID
- Write
Create custom role
Create a new custom role
- Write
Update custom role
Update a single custom role. Updating a custom role uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates. To add an element to the policy array, set the path to /policy and then append / .
- Destructive
Delete custom role
Delete a custom role by key
Teams
- Read
List teams
Return a list of teams. By default, this returns the first 20 teams. Page through this list with the limit parameter and by following the first, prev, next, and last links in the links field that returns. If those links do not appear, the pages they refer to don't exist.
- Read
Get team
Fetch a team by key. Expanding the teams response LaunchDarkly supports several fields for expanding the "Get team" response. By default, these fields are not included in the response.
- Read
Get team maintainers
Fetch the maintainers that have been assigned to the team. To learn more, read Managing team maintainers.
- Read
Get team custom roles
Fetch the custom roles that have been assigned to the team. To learn more, read Managing team permissions.
- Write
Create team
Create a team. To learn more, read Creating a team. Expanding the teams response LaunchDarkly supports four fields for expanding the "Create team" response. By default, these fields are not included in the response.
- Write
Update team
Perform a partial update to a team. Updating a team uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.
- Write
Add multiple members to team
Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column.
- Destructive
Delete team
Delete a team by key. To learn more, read Deleting teams.
Teams (beta)
- Write
Update teams
Perform a partial update to multiple teams. Updating teams uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.
Workflow templates
- Read
Get workflow templates
Get workflow templates belonging to an account, or can optionally return templatesendpoints.workflowTemplateSummariesListingOutputRep when summary query param is true
- Write
Create workflow template
Workflows are in maintenance mode The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. We will work with existing customers using workflows to migrate to a replacement solution when deprecation occurs.
- Destructive
Delete workflow template
Delete a workflow template
Access tokens
- Read
List access tokens
Fetch a list of all access tokens.
- Read
Get access token
Get a single access token by ID.
- Write
Create access token
Create a new access token.
- Write
Patch access token
Update an access token's settings. Updating an access token uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete access token
Delete an access token by ID.
Account usage (beta)
- Read
Get AI runs usage
Get a time series array showing the number of AI runs recorded for your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
- Read
Get contexts clientside usage
Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints.
- Read
Get MAU clientside usage
Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs.
- Read
Get data export events usage
Get a time series array showing the number of data export events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
- Read
Get evaluations usage
Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation.
- Read
Get events usage
Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested.
- Read
Get experimentation events usage
Get a time series array showing the number of experimentation events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
- Read
Get experimentation keys usage
Get a time series array showing the number of experimentation keys from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
- Read
Get MAU SDKs by type
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances.
- Read
Get observability errors usage
Get time-series arrays of the number of observability errors. Supports daily and monthly granularity.
- Read
Get observability logs usage
Get time-series arrays of the number of observability logs. Supports daily and monthly granularity.
- Read
Get observability metrics usage
Get time-series arrays of the number of observability metrics. Supports hourly, daily, and monthly granularity.
- Read
Get observability sessions usage
Get time-series arrays of the number of observability sessions. Supports daily and monthly granularity.
- Read
Get observability traces usage
Get time-series arrays of the number of observability traces. Supports daily and monthly granularity.
- Read
Get usage details for all SDK versions
Get detailed SDK version usage data for all versions observed in the last 24 hours in your account. Unlike the /details endpoint which returns only the max version per SDK, this endpoint returns all SDK versions for the specified filters. This data is refreshed hourly.
- Read
Get SDK versions usage details
Get detailed SDK version usage data for your account, including version information, EOL status, and relay proxy metadata. Refreshed hourly, returns the max version for each SDK observed in the last 24 hours, including those without EOL metadata available.
- Read
Get contexts serverside usage
Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints.
- Read
Get service connections usage
Get a time series array showing the number of service connection minutes from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
- Read
Get stream usage
Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned.
- Read
Get stream usage by SDK version
Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested.
- Read
Get stream usage SDK versions
Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days.
- Read
Get contexts total usage
Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints.
- Read
Get MAU total usage
Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. For past months, this reflects the context kind that was most recently marked as primary for that month.
- Read
Get Vega AI usage
Get time-series arrays of the number of Vega AI usage. Supports daily and monthly granularity.
- Read
Get warehouse Data Export usage
Get a time series array showing the number of rows exported to your warehouse Data Export destinations. The supported granularity varies by aggregation type. The maximum time range is 365 days.
- Read
Rank Streaming usage by project
Rank projects with usage in the requested range by successful Streaming transfers. Legacy rows are attributed through the account's complete current environment-to-project mapping.
Webhooks
- Read
List webhooks
Fetch a list of all webhooks.
- Read
Get webhook
Get a single webhook by ID.
- Write
Creates a webhook
Create a new webhook.
- Write
Update webhook
Update a webhook's settings. Updating webhook settings uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete webhook
Delete a webhook by ID.
Tags
- Read
List tags
Get a list of tags.
Agent Control
- Read
Show an AI Config's targeting
Retrieves a specific AI Config's targeting by its key
- Read
List AI Configs
Get a list of all AI Configs in the given project.
- Read
Get AI Config
Retrieve a specific AI Config by its key.
- Read
Get AI Config variation
Get an AI Config variation by key. The response includes all variation versions for the given variation key.
- Read
Get AI Config quick stats
Retrieve aggregate quick stats for AI Configs in a project.
- Read
Get AI Config metrics
Retrieve usage metrics for an AI Config by config key.
- Read
Get AI Config metrics by variation
Retrieve usage metrics for an AI Config by config key, with results split by variation.
- Read
List AI model configs
Get all AI model configs for a project.
- Read
Get AI model config
Get an AI model config by key. Specify a version to retrieve a historical custom model config version. Global model configs accept version 0 or 1 and return their current representation.
- Read
List AI model config versions
Get a paginated list of all available versions of an AI model config, ordered from newest to oldest. Global model configs return their single current representation.
- Read
List AI tools
Get a list of all AI tools in the given project.
- Read
List AI tool versions
Get a list of all versions of an AI tool in the given project.
- Read
List AI tool references
Get all AgentControl config variations that currently reference this tool.
- Read
Get AI tool
Retrieve a specific AI tool by its key.
- Read
List prompt snippets
Get a list of all prompt snippets in the given project.
- Read
Get a prompt snippet
Retrieve a specific prompt snippet by its key.
- Read
List prompt snippet references
Get all config variations that currently reference this prompt snippet.
- Read
List prompt snippet versions
Get all versions of a prompt snippet in the given project, ordered by version descending.
- Read
List agent skills
Get a list of all agent skills in the given project.
- Read
Get an agent skill
Retrieve a specific agent skill by its key.
- Read
List agent skill references
Get all config variations that currently reference this agent skill.
- Read
List agent skill versions
Get all versions of an agent skill in the given project, ordered by version descending.
- Read
List agent graphs
Get a list of all agent graphs in the given project. Returns metadata only, without edge data.
- Read
Get agent graph
Retrieve a specific agent graph by its key, including its edges.
- Read
List agent optimizations
Get a list of all agent optimizations in the given project.
- Read
Get an agent optimization
Retrieve a specific agent optimization by its key.
- Read
List latest agent optimization result per run
Get the most recent result for each unique run of an agent optimization.
- Read
List all agent optimization results across versions
Get all results across all versions of an agent optimization.
- Read
List agent optimization runs
Get one run summary per distinct runid across all versions of an agent optimization config, ordered by createdat DESC.
- Read
List agent optimization results for a run
Get all results for a specific run of an agent optimization, sorted by iteration descending.
- Write
Update AI Config targeting
Perform a partial update to an AI Config's targeting. The request body must be a valid semantic patch. Using semantic patches on an AI Config To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header.
- Write
Create new AI Config
Create a new AI Config within the given project.
- Write
Update AI Config
Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: { "description": "Example updated description", "tags": ["new-tag"] }
- Write
Create AI Config variation
Create a new variation for a given AI Config. The model in the request body requires a modelName and parameters , for example: "model": { "modelName": "claude-3-opus-20240229", "parameters": { "maxtokens": 1024 } }
- Write
Update AI Config variation
Edit an existing variation of an AI Config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields.
- Write
Add AI models to the restricted list
Add AI models, by key, to the restricted list. Keys are included in the response from the List AI model configs endpoint.
- Write
Create an AI model config
Create an AI model config. You can use this in any variation for any config in your project.
- Write
Update an AI model config
Update an AI model config.
- Write
Create an AI tool
Create an AI tool
- Write
Update AI tool
Edit an existing AI tool.
- Write
Create a prompt snippet
Create a new prompt snippet within the given project.
- Write
Update a prompt snippet
Update an existing prompt snippet. Creates a new version of the snippet.
- Write
Create an agent skill
Create a new agent skill within the given project.
- Write
Update an agent skill
Update an existing agent skill. Creates a new version of the skill.
- Write
Create new agent graph
Create a new agent graph within the given project.
- Write
Update agent graph
Edit an existing agent graph. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. If the update includes rootConfigKey or edges, both must be present and will be treated as full replacements.
- Write
Create agent optimization
Create a new agent optimization within the given project.
- Write
Update an agent optimization
Update an existing agent optimization. Creates a new version of the optimization.
- Write
Create agent optimization result
Create a new result for an agent optimization run.
- Write
Update an agent optimization result
Update status, activity, and AI request metadata fields on an agent optimization result.
- Destructive
Delete AI Config
Delete an existing AI Config.
- Destructive
Delete AI Config variation
Delete a specific variation of an AI Config by config key and variation key.
- Destructive
Remove AI models from the restricted list
Remove AI models, by key, from the restricted list.
- Destructive
Delete an AI model config
Delete an AI model config.
- Destructive
Delete AI tool
Delete an existing AI tool.
- Destructive
Delete a prompt snippet
Delete an existing prompt snippet.
- Destructive
Delete an agent skill
Delete an agent skill, including all of its versions.
- Destructive
Delete agent graph
Delete an existing agent graph and all of its edges.
- Destructive
Delete an agent optimization
Delete an existing agent optimization.
- Destructive
Delete an agent optimization run
Delete all results for a specific run of an agent optimization. Returns a 404 if the optimization does not exist or if the run has no results.
Announcements
- Read
Get announcements
Get announcements
- Write
Create an announcement
Create an announcement
- Write
Update an announcement
Update an announcement
- Destructive
Delete an announcement
Delete an announcement
Views
- Read
List views
Get a list of all views in the given project.
- Read
Get view
Retrieve a specific view by its key.
- Read
Get linked resources
Get a list of all linked resources for a given view.
- Read
Get linked views for a given resource
Get a list of all linked views for a resource. Flags and AI configs are identified by key. Segments are identified by segment ID.
- Write
Create view
Create a new view in the given project.
- Write
Update view
Edit an existing view. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: { "description": "Example updated description", "tags": ["new-tag"] }
- Write
Link resource
Link one or multiple resources to a view by keys, filters, or both: - Link flags using flag keys or filters (maintainerId, maintainerTeamKey, tags, state, query) - Link segments using segment IDs or filters (tags, query, unbounded) - Link AI configs using config keys When both k…
- Destructive
Delete view
Delete a specific view by its key.
- Destructive
Unlink resource
Unlink one or multiple resources from a view: - Unlink flags using flag keys - Unlink segments using segment IDs - Unlink AI configs using config keys
Release policies (beta)
- Read
List release policies
Get a list of release policies for the specified project with optional filtering.
- Read
Get a release policy by key
Retrieve a single release policy by its key for the specified project.
- Write
Create a release policy
Create a new release policy for the specified project.
- Write
Update the order of existing release policies
Update the order of existing release policies for the specified project.
- Destructive
Update a release policy
Update an existing release policy for the specified project.
- Destructive
Delete a release policy
Delete an existing release policy for the specified project.
Environment releases (beta)
- Read
List environment releases
Returns the environment releases for the flag in the environment, newest first. Each release includes its phases in phase-index order. Metric definitions are not included. To get them, call getEnvironmentRelease with expand=metrics.
- Read
Get an environment release
Returns an environment release and all its phases in phase-index order. The release ID must belong to the flag and environment in the path. Returns 404 for a release that ended more than 90 days ago.
- Write
Start an environment release
Creates and starts a release on a flag in an environment, either from inline configuration or from an environment release plan. A release has one or more phases.
- Destructive
Stop an environment release
Stops a release and resolves its phases according to the resolution you specify. To learn how each resolution treats completed and pending phases, read the resolution schema.
IP Allowlist (beta)
- Read
Get IP Allowlist
Get the current IP allowlist configuration and entries.
- Write
Create IP Allowlist Entry
Create a new IP allowlist entry.
- Write
Update IP Allowlist Configuration
Update sessionAllowlistEnabled and apiTokenAllowlistEnabled settings.
- Write
Update IP Allowlist Entry Description
Update the description of an IP allowlist entry.
- Destructive
Delete IP Allowlist Entry
Delete an IP allowlist entry by id.
SDK Keys (beta)
- Read
Get all project SDK keys
Get all SDK keys for a given project across environments.
- Read
Get all environment SDK keys
Get all SDK keys for a given project and environment. Can filter by kind.
- Read
Get SDK key
Get a specific SDK key by its key.
- Write
Create SDK key
Create a new server-side or mobile SDK key. Deleted SDK keys are retained for 180 days. During that period you cannot reuse the key of a deleted SDK key, even though the deleted key no longer appears in the list of SDK keys for the environment.
- Write
Update SDK key
Update a an existing SDK key by its identifying key.
- Destructive
Delete SDK key
Delete a specific SDK key by its key.
- Destructive
Replace SDK key views
Replace the set of views associated with an SDK key. The viewKeys field is required. To remove all views from the SDK key, pass an empty viewKeys array.
Adaptive triggers
- Read
List adaptive triggers
List all adaptive triggers for a resource.
- Read
Get an adaptive trigger
Get a single adaptive trigger.
- Write
Create an adaptive trigger
Create a new adaptive trigger for a resource.
- Write
Update an adaptive trigger
Update a single adaptive trigger.
- Write
Enable an adaptive trigger
Enable an adaptive trigger.
- Write
Disable an adaptive trigger
Disable an adaptive trigger.
- Destructive
Delete an adaptive trigger
Delete a single adaptive trigger.
Insights charts (beta)
- Read
Get deployment frequency chart data
Get deployment frequency chart data. Engineering insights displays deployment frequency data in the deployment frequency metric view. Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields.
- Read
Get stale flags chart data
Get stale flags chart data. Engineering insights displays stale flags data in the flag health metric view. Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields.
- Read
Get flag status chart data
Get flag status chart data. To learn more, read Flag statuses.
- Read
Get lead time chart data
Get lead time chart data. The engineering insights UI displays lead time data in the lead time metric view.
- Read
Get release frequency chart data
Get release frequency chart data. Engineering insights displays release frequency data in the release frequency metric view.
Insights deployments (beta)
- Read
List deployments
Get a list of deployments Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields.
- Read
Get deployment
Get a deployment by ID. The deployment ID is returned as part of the List deployments response. It is the id field of each element in the items array. Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields.
- Write
Create deployment event
Create deployment event
- Write
Update deployment
Update a deployment by ID. Updating a deployment uses a JSON patch representation of the desired changes. To learn more, read Updates. The deployment ID is returned as part of the List deployments response. It is the id field of each element in the items array.
Insights flag events (beta)
- Read
List flag events
Get a list of flag events Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields.
Insights scores (beta)
- Read
List insight groups
List groups for which you are collecting insights Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields.
- Read
Get insight group
Get insight group Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields.
- Read
Get insight scores
Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views.
- Write
Create insight group
Create insight group
- Write
Patch insight group
Update an insight group. Updating an insight group uses a JSON patch representation of the desired changes. To learn more, read Updates.
- Destructive
Delete insight group
Delete insight group
Insights pull requests (beta)
- Read
List pull requests
Get a list of pull requests Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields.
Insights repositories (beta)
- Read
List repositories
Get a list of repositories Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields.
- Destructive
Associate repositories with projects
Associate repositories with projects
- Destructive
Remove repository project association
Remove repository project association
No operations match.
See How connections work for access and permissions, or browse all integrations.