Repository navigation
v25.0.0
·
2 commits
to main
since this release
Immutable
release. Only release title and notes can be modified.
Added
- Added optional
classifierson AgentControl config variations. Send a non-empty array to store classifier rules on a judge variation;messagesmust be empty. Send an empty array to clear stored classifier rules. Responses includeclassifiersonly when rules are stored. Affected endpoints:POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variationsPATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations- Config and variation read responses that return variation objects
- Added Environment releases (beta) endpoints for starting, stopping, and viewing guarded and progressive releases on a flag in one environment. Starting a release runs release health checks and returns
400with codehealth_checks_failedwhen they fail.originalVariationValueandtargetVariationValuehold the flag's variation values, which can be any JSON type. These are beta endpoints and require theLD-API-Version: betaheader:GET /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releasesPOST /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releasesGET /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}PUT /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}/stop
Changed
- Renamed the release pipelines schemas that start with
Releaseso they are not confused with the environment releases schemas. This only changes the schema names in the OpenAPI spec and the type names in generated API clients. The JSON returned by the API is unchanged. Renamed schemas:ReleasetoPipelineReleaseCreateReleaseInputtoCreatePipelineReleaseInputReleaseAudiencetoPipelineReleaseAudienceReleaserAudienceConfigInputtoPipelineReleaseAudienceConfigInputReleaseProgressiontoPipelineReleaseProgressionReleaseProgressionCollectiontoPipelineReleaseProgressionCollectionReleaseStrategytoPipelineReleaseStrategyReleaseGuardianConfigurationtoPipelineReleaseGuardianConfigurationReleaseGuardianConfigurationInputtoPipelineReleaseGuardianConfigurationInput
- Deprecated the release pipelines endpoints, and renamed the
Release pipelines (beta)tag toRelease pipelines (deprecated). The endpoints still require theLD-API-Version: betaheader, and request behavior is unchanged. Affected endpoints:GET /api/v2/projects/{projectKey}/release-pipelinesPOST /api/v2/projects/{projectKey}/release-pipelinesGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}DELETE /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releasesPUT /api/v2/projects/{projectKey}/flags/{flagKey}/releasePUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}GET /api/v2/flags/{projectKey}/{flagKey}/releasePATCH /api/v2/flags/{projectKey}/{flagKey}/releaseDELETE /api/v2/flags/{projectKey}/{flagKey}/release
- Documented the AI tool and agent skill fields on the
/api/v2/projects/{projectKey}/ai-configs/toolsand/api/v2/projects/{projectKey}/ai-configs/skillsendpoints.version,tags, andcustomParameterson AI tools, andname,description,tags, andversionon agent skills, now have descriptions and examples.versionis the value to pass in a variation'stoolsorskillslist. Thestatefield on AI Config variation responses is now documented as an enum with the valuesarchivedandpublished. Response and request behavior is unchanged. - Added a
tagsfilter toGET /api/v2/projects/{projectKey}/ai-configs/skills. Usefilter=tags anyOf ["tag-a", "tag-b"]to return agent skills whose latest version has at least one of the tags. It can be combined with the existingqueryandkeyfilters. GET /api/v2/tagsnow acceptsagent-skillas akind, and returns agent skill tags. When nokindis set, the response now also includes agent skill tags.- Documented the AI model config fields on the
/api/v2/projects/{projectKey}/ai-configs/model-configsendpoints. Field descriptions and examples now cover theProvider.model-idkey format, the difference betweenkeyand the provider modelid,global,isRestricted,version,tags, maintainer fields, token costs, and the freeformparamsandcustomParamsobjects. The restricted models request and response fields are also documented. Request behavior is unchanged. - Added explicit
formatvalues to numeric fields that previously had none: Goint64fields now emitformat: int64and Gofloat64fields now emitformat: double. The JSON returned by the API is unchanged -- these fields already carried 64-bit values -- but generated API clients will now type them as 64-bit rather than defaulting to 32-bit. This fixes truncation of large values such as Unix millisecond timestamps inSeriesTimeSliceRep. 41 fields are affected, across the usage, flags, metrics, projects, and destinations endpoints. - Moved the releases endpoints from the
Releases (beta)tag to theRelease pipelines (beta)tag, so they are grouped with the other release pipeline endpoints in the documentation. Removed theReleases (beta)tag. Affected endpoints:PUT /api/v2/projects/{projectKey}/flags/{flagKey}/releasePUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}GET /api/v2/flags/{projectKey}/{flagKey}/releasePATCH /api/v2/flags/{projectKey}/{flagKey}/releaseDELETE /api/v2/flags/{projectKey}/{flagKey}/release
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experimentsnow defaultsmethodologytofrequentistwhen it is not provided. Multi-armed bandit experiments still default tobayesian. Requests that setmethodologyare unchanged.- Corrected the holdouts API description. It previously said you can delete holdouts, but there is no delete endpoint. You can create, update, and end holdouts. To end a holdout, use the
endHoldoutinstruction onPATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}. Request behavior is unchanged. - Removed the beta tag from the views API. These endpoints no longer require the
LD-API-Version: betaheader. Affected endpoints:GET /api/v2/projects/{projectKey}/viewsPOST /api/v2/projects/{projectKey}/viewsGET /api/v2/projects/{projectKey}/views/{viewKey}PATCH /api/v2/projects/{projectKey}/views/{viewKey}DELETE /api/v2/projects/{projectKey}/views/{viewKey}POST /api/v2/projects/{projectKey}/views/{viewKey}/link/{resourceType}DELETE /api/v2/projects/{projectKey}/views/{viewKey}/link/{resourceType}GET /api/v2/projects/{projectKey}/views/{viewKey}/linked/{resourceType}GET /api/v2/projects/{projectKey}/view-associations/{resourceType}/{resourceKey}
- Documented
modelConfigKeyon AgentControl config variations. Use the model config'skeyfromGET /api/v2/projects/{projectKey}/ai-configs/model-configs, such asOpenAI.gpt-4.1. Do not use a custom model config'sid, which is the provider model ID. AmodelConfigKeythat does not match a model config still returns a400, and the error message now names the key. Affected endpoints:POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variationsPATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}
- The
kindKey,kindKeys, andkindsfilters onPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/searchnow accept at most 1000 values per request; larger lists are rejected with a400. Previously an oversized list failed the whole search once the generated query exceeded the search backend's maximum query size. Split larger lists across multiple requests. - The
dynamicOptionsobject on integration manifest form variables now also reportssource,filters, andallowUnknownValue. This lets adynamicEnumfield draw its options from a named LaunchDarkly catalog instead of the integration's own endpoint, narrow them by a sibling form variable, and keep a saved value that is no longer in the catalog. Existingendpoint/parserdynamic options are unchanged. New read-only schemas includeDynamicOptionsSourceandDynamicOptionFiltersItems. Affected endpoints:GET /api/v2/integration-capabilitiesGET /api/v2/integration-configurations/{integrationConfigurationId}GET /api/v2/integration-configurations/keys/{integrationKey}
- Documented the
statefield onPATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}. The field is now an enum with the valuesarchivedandpublished. The description states what each value does and when the API rejects it. An AI Config itself cannot be archived. Request behavior is unchanged. - Corrected the
basePermissionsdescription for custom roles. OmittingbasePermissionsonPOST /api/v2/rolesdefaults toreader. The description previously said the default wasno_access. Request behavior is unchanged. - Documented the agent skill key format on
POST /api/v2/projects/{projectKey}/ai-configs/skills. Thekeyfield description now states that keys must match^[a-z0-9][a-z0-9-]*$(lowercase letters, numbers, or-, starting with a lowercase letter or number), can be at most 64 characters, and can't be a Windows reserved file name such asconornul. The API rejects keys that break these rules with a400. - Added the
405method not allowed response to flag trigger create and update. It is returned when the environment requires approval for the stored flag change and the caller cannot bypass that requirement. Affected endpoints:POST /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}
- Exposed the new
expiryfield on access tokens in the public OpenAPI spec. - Corrected the documented granularity rule on
GET /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey}: granularity is selected by the length of the requested range (under two hours minutely, under two days hourly, two days or longer daily), not by the age of the data. Documented that minutely data is retained for 70 days and that a sub-two-hour range starting beyond that is returned at hourly granularity (with the range start widened to the containing hour), that ranges predating available data return an empty series list, and that when a flag has served many distinct variation values the least recently seen values may be aggregated into an additional series labeled "Other Variations". - Environment-grouped usage metadata now includes
projectKeyandprojectName. On the/api/v2/usageendpoints, a series grouped byenvironmentIdwithoutprojectIdnow also carries the key and name of the environment's current project. Series grouped byprojectIdare unchanged. - Updated
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/searchandGET /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{kind}/{key}to document current behavior:- Search results are sorted by context kind and key, return one item per context with its most recently reported attributes, and include contexts received within the last 30 days. Get contexts returns one item per application, with
applicationIdpopulated. totalCountis an approximation and may be omitted if it is unavailable.associatedContextsis deprecated and always returns1.applicationIdon search result items is always an empty string; it is populated only on Get contexts items.
- Search results are sorted by context kind and key, return one item per context with its most recently reported attributes, and include contexts received within the last 30 days. Get contexts returns one item per application, with
- Updated the supported filter fields and operators for
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/search:- The
idfield is no longer supported. - The
kindsandkindKeysfields match the context's own kind and kind:key. Theircontainsoperator accepts exactly one value;notEqualsis not supported. anyOfis supported only on theapplicationId,key,kind,kindKey,kindKeys, andkindsfields. For attributes, useequalswith an array value, which matches any element.- The
qfield accepts a single string and performs a prefix search across the context key and thename,firstName,lastName, andemailattributes. - Attribute filter path segments must be simple names (letters, numbers, underscores, hyphens); reference nested attributes by joining segments with periods. JSON pointer escaping (
~0,~1) is no longer supported. A filter may include at most 10 attribute clauses.startsWithvalues are limited to 500 characters and matching is case-sensitive.
- The
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes/{attributeName}now requires akindfilter; requests without one are rejected with a400.- Continuation tokens issued before this change are no longer valid on the contexts search and get endpoints. Requests that use one receive a
400; restart pagination from the first page. - Deprecated the
sortquery parameter on the contexts and context instances search and get endpoints. These endpoints do not support sorting, and requests that includesortare rejected with a400. Results are returned in the order the search backend produces them, which is not configurable. Omit the parameter. Affected endpoints:POST /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/searchGET /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{kind}/{key}POST /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/searchGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}
- Clarified that
projectKeyonGET /api/v2/usage/data-export-eventscan be used withoutenvironmentKeyto scope Data Export events to whole projects. Previously,projectKeywithoutenvironmentKeycould return account-wide data. GET /api/v2/usage/data-export-eventsnow acceptsgroupBy=projectIdwhen one to 100projectKeyfilters are provided. It returns409instead of a partial series when any successful usage row in the requested range remains unattributed after resolution through the account's current environment-to-project mapping; plain project filtering keeps its compatibility behavior.projectKeywithoutenvironmentKeyonGET /api/v2/usage/experimentation-eventsnow filters usage to the selected projects' current environments. A selected project with no current environments returns an empty series instead of account-wide usage.projectKeywithoutenvironmentKeyonGET /api/v2/usage/experimentation-keysnow filters usage by every selected project ID, including projects with no current environments, so retained materialized usage remains available instead of returning account-wide usage.- On both Experimentation usage endpoints, an unrecognized
projectKeynow returns400instead of being ignored. - The
redshiftSetupScriptsfield on the integration configuration resource is now also returned for active (finalized) Redshift native Experimentation configurations, rehydrated from the persisted configuration. It was previously present only on the two-step setup endpoint responses. The scripts are regenerated from the stored configuration on read and are not persisted, so the returned values are unchanged. Affected endpoints:GET /api/v2/integration-configurations/{integrationConfigurationId}GET /api/v2/integration-configurations/keys/{integrationKey}
- Data Export destination
GET,PATCH, andDELETErequests now return404when the destination does not belong to the environment in the request URL. Affected endpoints:GET /api/v2/destinations/{projectKey}/{environmentKey}/{id}PATCH /api/v2/destinations/{projectKey}/{environmentKey}/{id}DELETE /api/v2/destinations/{projectKey}/{environmentKey}/{id}
- Direct updates to AgentControl config variations now return
403when a changed variation is in use in an environment that requires approval. A variation is in use when its backing flag variation is referenced by fallthrough, a targeting rule, an individual or context target, or a non-zero percentage rollout. Affected endpoints:PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations
- Deprecated the
sdkTypequery parameter and thesdkTypegroupByvalue onGET /api/v2/usage/service-connections. Both are still accepted. This endpoint reports server-side connections only. For client-side connections, useGET /api/v2/usage/streams/{source}. - Renamed the
DependentMeasuredRolloutRepschema toDependentReleasePhaseRep. This only changes the schema name in the OpenAPI spec and the type name in generated API clients. The JSON returned by the API is unchanged. The schema appears in theguardedRolloutsfield of the metric resource. Affected endpoints:GET /api/v2/metrics/{projectKey}POST /api/v2/metrics/{projectKey}GET /api/v2/metrics/{projectKey}/{metricKey}PATCH /api/v2/metrics/{projectKey}/{metricKey}DELETE /api/v2/metrics/{projectKey}/{metricKey}
- Renamed the
ReleasePhaseschema toPipelineReleasePhase. This only changes the schema name in the OpenAPI spec and the type name in generated API clients; the JSON returned by the API is unchanged. Affected endpoints:GET /api/v2/flags/{projectKey}/{flagKey}/releasePATCH /api/v2/flags/{projectKey}/{flagKey}/releaseDELETE /api/v2/flags/{projectKey}/{flagKey}/releasePUT /api/v2/projects/{projectKey}/flags/{flagKey}/releasePUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}
POST /api/v2/projects/{projectKey}/viewsnow converts thekeyin the request body to lowercase before it creates the view. The lowercase key is what the response returns, what the uniqueness check compares against, and what role policy resource specifiers must use. Views created before this change keep their original casing, and the other view endpoints continue to match keys exactly as stored.- Updated the
DELETE /api/v2/metrics/{projectKey}/{metricKey}description to state that a metric must be archived before it can be deleted. Added the409status conflict response returned when a metric cannot be deleted because it is not archived or is still in use by an experiment, guarded rollout, metric group, or release policy. - Updated the
POST /api/v2/membersdescription to document that theteamKeysfield requires the teams entitlement, which is available only on Enterprise plans. A request that includes a non-emptyteamKeysfield on a plan without that entitlement is rejected with a403, and no members are created. OmittingteamKeyscontinues to work on every plan that allows member management. - Made
expiryon the access token API resource public. - Clarified the descriptions of
trackEvents(feature flag and flag rule),trackEventsFallthrough, anddefaultTrackEvents(environment): enabling them sends detailed evaluation events, which is required for Data Export, but doesn't enable Data Export on its own. - Moved
GET /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey}/runsandGET /api/v2/projects/{projectKey}/ai-tools/{toolKey}/referencesfrom theAI Configstag to theAgentControltag, so they are grouped with the other AgentControl endpoints in the documentation. - Renamed the summary of
GET /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey}/resultsfrom "List agent optimization runs" to "List latest agent optimization result per run". It previously shared a title with the/runsendpoint even though the two return different data:/resultsreturns the most recent full result for each run of the current optimization version, while/runsreturns a lightweight run summary per run across all versions. - Grouped the adaptive triggers endpoints under the new
Adaptive triggerstag, so they now appear in their own section of the API documentation. Affected endpoints:POST /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggersGET /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggersGET /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}POST /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}/enablePOST /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}/disable
- Updated the
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keysdescription to document that deleted SDK keys are retained for 180 days. During that period you cannot reuse thekeyof a deleted SDK key, even though the deleted key no longer appears in the list of SDK keys for the environment. A request that reuses such a key is rejected with a400. This documents existing behavior; the endpoint is unchanged. - Updated the following query params in the
GET /api/v2/projects/{projectKey}/sdk-keysendpoint:- Added
viewKeyandenvironmentKeyvalues tofilter - Added
viewSummariesvalue toexpand
- Added
- Added the
422unprocessable entity response toPATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}. It is returned when the instructions in the request are well formed, but cannot be applied to the experiment as it currently stands. Requests that succeed today are unaffected. - Release policies (beta) now accept at most 10 stages in
guardedReleaseConfig.stagesandprogressiveReleaseConfig.stagesby default. Some accounts have a higher limit, up to 20 stages, which is the schema'smaxItems. Stages are also validated: each stage must have anallocationgreater than 0 and greater than the previous stage's, at most 50% (50000) for guarded releases or 100% (100000) for progressive releases, and adurationMillisgreater than 0. Requests that break these rules are rejected with a400. Existing release policies can still be read, deleted, and applied, but aPUTthat sends back more stages than the account's limit, or invalid stages, is rejected until the stages are fixed. Affected endpoints:POST /api/v2/projects/{projectKey}/release-policiesPUT /api/v2/projects/{projectKey}/release-policies/{policyKey}
- Limited
scope.flagTagKeyson release policies (ReleasePolicyScope). A policy can have at most 1000 flag tag keys. Flag tag keys have the same limitations as flag tags: each key must only contain letters, numbers,-,_, or., and be at most 64 characters. Requests that exceed these limits are rejected with a400. Existing policies stay readable and deletable, but aPUTmust drop or fix any stored keys that are over these limits. Affected endpoints:POST /api/v2/projects/{projectKey}/release-policiesPUT /api/v2/projects/{projectKey}/release-policies/{policyKey}
Added
- Added the optional
clickHouseSetupScriptfield to the integration configuration resource for ClickHouse native Experimentation. It holds the SQL grants the customer runs in ClickHouse, regenerated from the stored configuration, and never contains a password. Affected endpoints:GET /api/v2/integration-configurations/{integrationConfigurationId}GET /api/v2/integration-configurations/keys/{integrationKey}
- Added the
Environment releases (beta)API tag and its documentation for listing, retrieving, starting, and stopping environment releases. - Added
environmentKeyas a supported value for thesortquery parameter onGET /api/v2/projects/{projectKey}/sdk-keys. It orders SDK keys by environment key ascending, then by creation time ascending within each environment, so each page is environment-contiguous.createdAtand-createdAtare unchanged. - Added the optional top-level
dataThroughanddelayedfields to the responses ofGET /api/v2/usage/data-export-eventsandGET /api/v2/usage/warehouse-export.dataThroughis the end of the latest hour that the source's usage pipeline has written across all accounts, as an RFC 3339 UTC timestamp.delayedistruewhen the source wrote every hour of the 24 hours ending atdataThroughand more than three hours have passed sincedataThrough. It is alwaysfalsefor a source with gaps in those 24 hours. Both fields are omitted when the watermark is unavailable. The response schema is nowDataExportSeriesListRep, which adds these two fields toSeriesListRep. - Added
groupBy=destinationIdtoGET /api/v2/usage/data-export-eventsandGET /api/v2/usage/warehouse-export. Each destination series hasdestinationIdanddestinationNamemetadata,destinationViewablewhen a current destination matches. The destination's own kind is added asdestinationKindonly when the caller can view the destination; a kind requested withgroupBy=destinationKindis returned unchanged. Warehouse series use the LaunchDarkly destination ID when a current destination the caller can view matches, and the warehouse provider's destination ID, namedUnknown destination, when none matches. Destinations the caller cannot view are combined into oneUnknown destinationseries withdestinationIdhiddenanddestinationViewablefalse, one per combination of the other requested dimensions. Streaming IDs absent from the current configuration are namedUnknown historical destination. Usage without a destination ID is one series with an emptydestinationId, namedUnattributed. - Added the
sortquery parameter toGET /api/v2/teams. Supported fields arenameandmemberCount. Prefix a field with-to sort in descending order, and separate multiple fields with commas to break ties. Whensortis omitted, teams are ordered by creation date, newest first, as before. - Added the optional
destinationKindquery parameter andgroupBy=destinationKindtoGET /api/v2/usage/data-export-eventsandGET /api/v2/usage/warehouse-export. Values preserve source configuration/product identity: Streaming Snowflake issnowflake, Warehouse Snowflake issnowflake-v2, and they remain distinct Destination Types. The WarehousedestinationKindfilter acceptssnowflake-v2,databricks,bigquery,redshift,clickhouse, ands3. It cannot be combined with the existingdestinationfilter, which retains its five pre-existing values and excludess3;groupBy=destinationand response metadata remain unchanged. - Added the beta
GET /api/v2/usage/data-export-events/projects/rankingendpoint for bounded Streaming project ranking with explicit UTC bounds, selected project keys, search, cursor pagination, deterministic rank ordinals, and per-source counts. It returns409instead of a partial ranking when any successful usage row in the requested range remains unattributed after resolution through the account's current environment-to-project mapping. - Added the optional
includePendingquery parameter toGET /api/v2/integration-configurations/keys/{integrationKey}. Whentrue, the response includes pending two-step setup drafts that were created using/setupbut are not yet finalized. It defaults tofalse, which returns only active configurations, matching the previous behavior. - Added
notifyTeamKeysto the approval request resource. It lists the team keys sent innotifyTeamKeyswhen the approval request was created or when reviewers were added, so you no longer have to track that separately. The members of those teams are resolved when the request is made and are listed innotifyMemberIds. Team membership may have changed since. The field is omitted for approval requests created without team keys, including every request created before this change. Affected endpoints:GET /api/v2/approval-requestsPOST /api/v2/approval-requestsGET /api/v2/approval-requests/{id}PATCH /api/v2/approval-requests/{id}POST /api/v2/approval-requests/{id}/applyPOST /api/v2/approval-requests/{id}/reviewsGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requestsPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requestsPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copyGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/applyPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews
- Added
isAgentandiconUrlto theappobject on audit log entries.isAgentistruewhen the application acted on behalf of the member named in the same entry, so the two are co-authors of the change rather than the member acting alone. It is omitted for applications that act on their own.iconUrlis the application's icon, when it has one. Affected endpoints:GET /api/v2/auditlogGET /api/v2/auditlog/{id}
- Added adaptive triggers endpoints, which automatically change a flag or AgentControl config's targeting when an observability alert fires
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggersGET /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggersGET /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}POST /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}/enablePOST /api/v2/projects/{projectKey}/environments/{environmentKey}/adaptive-triggers/{triggerID}/disable
- Added optional
sortandfilterquery parameters toGET /api/v2/projects/{projectKey}/ai-configs/model-configs.sortacceptsversion,tags, andusedIn. Prefix a field with-for descending order.filteracceptsquery,tags,maintainerId, andmaintainerTeamKey. - Added the optional
usedInCountproperty to theModelConfigrepresentation. It is the number of distinct AgentControl configs that reference the model. Affected endpoints:GET /api/v2/projects/{projectKey}/ai-configs/model-configsPOST /api/v2/projects/{projectKey}/ai-configs/model-configsGET /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}PATCH /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}GET /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}/versions
- Added the optional read-only
unitAggregationFieldproperty to the metric representation, reporting the column whose distinct values are counted forcount_distinctmetrics. It was already returned on the ratiodenominatorrepresentation; it is now also documented on the top-level metric representation, so it appears wherever a metric is returned. Affected endpoints:GET /api/v2/metrics/{projectKey}POST /api/v2/metrics/{projectKey}GET /api/v2/metrics/{projectKey}/{metricKey}PATCH /api/v2/metrics/{projectKey}/{metricKey}GET /api/v2/flags/{projectKey}POST /api/v2/flags/{projectKey}GET /api/v2/flags/{projectKey}/{featureFlagKey}PATCH /api/v2/flags/{projectKey}/{featureFlagKey}POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy
- Added a read-only, relative
_site/_links.sitelink to several resource representations, pointing at the resource's page in the LaunchDarkly UI so consumers can deep-link without hardcoding routes or hosts (environment-scoped where the UI page is). Added to the AgentControl (AI Config), AI tool, prompt snippet, and agent graph representations, and to the_links.siteof project, experiment, and approval request representations. Also corrected a stale_siteexample on the metric representation. Affected endpoints:GET /api/v2/projects,GET /api/v2/projects/{projectKey}GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments,GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}GET /api/v2/approval-requests,GET /api/v2/approval-requests/{id}GET /api/v2/projects/{projectKey}/ai-configs,GET /api/v2/projects/{projectKey}/ai-configs/{configKey}
- Added the optional
memberquery parameter toGET /api/v2/auditlog,POST /api/v2/auditlog, andPOST /api/v2/auditlog/counts. It filters results to entries for changes made by the specified member, and may be repeated to filter by multiple members. - Added the optional
tokenquery parameter toGET /api/v2/auditlog,POST /api/v2/auditlog, andPOST /api/v2/auditlog/counts. It filters results to entries for changes made by the specified access token, and may be repeated to filter by multiple tokens. - Added the optional
defaultVariationKeyproperty to the request body ofPATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}. It sets which variation the config serves by default, so you no longer need to edit the underlying flag's default variation directly. - Added
PUT /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey}/viewsendpoint for replacing the set of views associated with an SDK key. TheviewKeysfield is required. To remove all views from the SDK key, pass an emptyviewKeysarray. Supportsexpand=viewSummaries. - Added
viewKeysfield to request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keysendpoint. - Added the
criticalfilter value toGET /api/v2/projects/{projectKey}/environments.filter=critical:truereturns only environments marked as critical, andfilter=critical:falsereturns only non-critical environments. It combines with the existingqueryandtagsfilter values. - Added the optional
clientNameproperty to the response ofGET /api/v2/caller-identity. For an OAuth access token, it is the registered name of the OAuth client the token was issued to. It is omitted for other kinds of credentials, and when the client's name can't be resolved. - Added the optional
audienceandexpiresAtproperties to the response ofGET /api/v2/caller-identity. For an OAuth access token,audiencelists the resources (RFC 8707) the token was issued for, andexpiresAtis when the token expires.audienceis omitted for tokens issued without a resource, and both are omitted for other kinds of credentials.
Removed
- Removed the context instances endpoints from the public API documentation:
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/searchGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}