v23.0.0

Added - Added optional outputFormat field to AgentControl variation request and response schemas. When set, specifies a JSON Schema defining the structured output format sent to the model. Controlled by the enable-ai-config-output-format feature flag. Affected endpoints: - GET /api/v2/projects/{projectKey}/ai-configs - POST /api/v2/projects/{projectKey}/ai-configs - GET /api/v2/projects/{projectKey}/ai-configs/{configKey} - PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey} - POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations - GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} - PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} - Added optional mfaEnforced (boolean) and mfaGracePeriodExpiresAt (Unix milliseconds timestamp) fields to the member representation. These fields indicate whether MFA enrollment is enforced for the member and when a grace period expires, if applicable. Both fields are omitted from responses when MFA enforcement is not active. - Added SDK Keys (beta) API tag with documentation for creating, retrieving, and managing additional server-side and mobile SDK keys for environments. - Added optional contextKind and contextKey query parameters to GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics and GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics-by-variation. These parameters allow filtering AI Config monitoring metrics to a specific context. - Added read-only valueHash to the Variation schema: a deterministic hash of the canonicalized variation value. Computed server-side; ignored if supplied in request bodies. Affected endpoints: - GET /api/v2/approval-requests - GET /api/v2/approval-requests/{id} - 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 GET /api/v2/usage/warehouse-export endpoint, which returns warehouse Data Export usage (rows transferred) over a time range. Supports the same from, to, aggregationType, groupBy, and filtering query parameters as the other usage endpoints. This is a beta endpoint and requires the LD-API-Version: beta header. - Added optional analysisType field (mean | percentile) to the MetricV2Rep and MetricInGroupRep schemas, indicating how metric events are analyzed. Affected endpoints include any response that returns a metric group or embeds a MetricV2Rep summary: - GET /api/v2/projects/{projectKey}/metric-groups - POST /api/v2/projects/{projectKey}/metric-groups - GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} - PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} - Added winsorIncludeImputed optional field to the metrics endpoints. When true, the winsorization percentile bound calculation includes imputed zeros (only meaningful when at least one bound is set). Defaults to false. Affected endpoints: - GET /api/v2/metrics/{projectKey} - POST /api/v2/metrics/{projectKey} - GET /api/v2/metrics/{projectKey}/{metricKey} - PATCH /api/v2/metrics/{projectKey}/{metricKey} - Added hasPassword boolean field to member representations. Indicates whether the member has a password set (basic auth). False for OAuth-only or SCIM-provisioned members. Affected endpoints: - GET /api/v2/members - GET /api/v2/members/{id} - PATCH /api/v2/members/{id} - Added optional tags field to AI tool request and response schemas. Tags can now be set on create and update, and are returned in all read responses. Affected endpoints: - POST /api/v2/projects/{projectKey}/ai-tools - PATCH /api/v2/projects/{projectKey}/ai-tools/{toolKey} - GET /api/v2/projects/{projectKey}/ai-tools - GET /api/v2/projects/{projectKey}/ai-tools/{toolKey} - Added DELETE /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey}/runs/{runId} endpoint to delete all results for a specific agent optimization run. This is a beta endpoint and requires the LD-API-Version: beta header. - Added an optional _maintainerId field (the ID of the member who maintains the integration configuration; defaults to the member who created it) to integration configuration responses. Affected endpoints: - GET /api/v2/integration-configurations/keys/{integrationKey} - POST /api/v2/integration-configurations/keys/{integrationKey} - GET /api/v2/integration-configurations/{integrationConfigurationId} - PATCH /api/v2/integration-configurations/{integrationConfigurationId} - Added optional clickHouseDatabaseName, clickHouseUserName, clickHouseS3BucketName, clickHouseIncludeHostRestriction, clickHouseServiceRoleArn, and clickHousePassword properties to the request body of POST /api/v2/destinations/projects/{projKey}/environments/{envKey}/kinds/{kind}/setup. The first three allow customers to customize names used in the generated setup script (defaults are used when omitted). When clickHouseIncludeHostRestriction is true, the generated CREATE USER statement includes a HOST IP clause restricting the export user to LaunchDarkly's region-specific egress IP for the customer's instance. When clickHouseServiceRoleArn is provided, it is baked into the generated IAM trust policy so the customer's ClickHouse Cloud service role can assume the S3 role. When clickHousePassword is provided, it is embedded directly in the CREATE USER statement so the generated script is ready to run without manual editing. - Exposed the existing s3BucketName property in the response of POST /api/v2/destinations/projects/{projKey}/environments/{envKey}/kinds/{kind}/setup (previously hidden from the public OpenAPI spec). The auto-generated S3 staging bucket name is returned for ClickHouse and Redshift setup calls so callers can render it back to the customer for the IAM trust policy step. The field continues to be omitted for kinds that do not stage data through S3. - Added optional endpoint property to the request body of POST /api/v2/destinations/projects/{projKey}/environments/{envKey}/kinds/{kind}/setup. When provided for a Redshift setup call alongside clusterIdentifier, clusterRegion, and clusterAwsAccountId, the cluster JDBC endpoint is persisted on the pending destination. This means POST /api/v2/destinations/projects/{projKey}/environments/{envKey}/kinds/{kind}/complete-setup can later reuse it without callers having to re-supply the value. The field is unused for other kinds. - Added optional databaseName, schemaName, and userName properties to the Redshift config object on the legacy POST /api/v2/destinations/{projectKey}/{environmentKey} endpoint. When provided, they override the default Redshift SQL object names the destination will write to; when omitted, the environment-scoped defaults (ld_export for the database, export_<projectKey>__<environmentKey> for the schema, ld_export_user_<projectKey>__<environmentKey> for the user) are now persisted on the resulting record. Customer-provided values are whitespace-trimmed before persistence. - Added optional filter query parameter to GET /api/v2/projects/{projectKey}/agent-optimizations for case-insensitive substring search across key, label, and ai_config_key fields. - Added denominator field to metric responses for ratio metrics. The denominator object describes the denominator event configuration (event name, aggregation type, data source, etc.) and is now included in the OpenAPI schema. Affected endpoints: - GET /api/v2/metrics/{projectKey} - GET /api/v2/metrics/{projectKey}/{metricKey} - POST /api/v2/metrics/{projectKey} - PATCH /api/v2/metrics/{projectKey}/{metricKey} - GET /api/v2/projects/{projectKey}/experiments (via MetricListingRep and MetricAnalysisRep) - GET /api/v2/projects/{projectKey}/experiments/{experimentKey} (via embedded metric fields) - Added optional filter query parameter to GET /api/v2/projects/{projectKey}/agent-graphs - Added an optional _access field (the current member's allowed and denied actions) to experiment responses, so clients can gate experiment actions per role. Affected endpoints: - GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments - POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments - GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} - PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} - GET /api/v2/projects/{projectKey}/experiments - The baseExperiment and relatedExperiments properties on the holdout endpoints (POST/GET/PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts...) - Added denominator, unitAggregationField optional fields to POST /api/v2/metrics/{projectKey} - Added dataSource field to the DenominatorPost schema (was missing from spec, causing all ratio metric creation requests to fail with 400) - Added new public endpoints for SDK key management: - POST /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys for creating a new SDK key on an environment. - DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey} for deleting an SDK key by identifying key. - GET /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey} for retrieving an SDK key by identifying key. - PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey} for updating an SDK key by identifying key. - Added winsorLowerPercentile, winsorUpperPercentile, and winsorExcludeImputed optional fields to the metrics endpoints: - GET /api/v2/metrics/{projectKey} - ...

v22.0.0

Added - Removed guardrail from the available types for POST /api/v2/projects/{projectKey}/metric-groups - Added POST /api/v2/auditlog/counts endpoint that returns aggregate counts of audit log entries per time bucket, used for dashboard overlays showing flag targeting changes. - Added expand=releasePolicyCount to GET /api/v2/{projectKey}/metrics. - Added expand=releasePolicyCount and expand=releasePolicies to GET /api/v2/{projectKey}/metrics/{metricKey} - Added releasePolicies and releasePolicyCount expansions to GET api/v2/metrics/{projectKey}/{metricGroupKey} - Added POST /api/v2/chart/data endpoint for chart data (event-warehouse integration). - Added scopes property to GET /api/v2/caller-identity response. This returns the OAuth scopes associated with the caller's token when authenticated via OAuth. - Added dependencies property to the GET /api/v2/projects/{projectKey}/ai-configs/{configKey} response, listing resources that depend on this AI Config (such as agent graphs). - Added _access property to agent graph responses. This field communicates the actions the current user is allowed or denied on the resource, enabling frontend permission checks. Affected endpoints: - POST /api/v2/projects/{projectKey}/agent-graphs - GET /api/v2/projects/{projectKey}/agent-graphs - GET /api/v2/projects/{projectKey}/agent-graphs/{graphKey} - PATCH /api/v2/projects/{projectKey}/agent-graphs/{graphKey} - Added customParameters field to variation tools in AI Config endpoints. This field provides custom metadata and configuration for application-level use: - GET /api/v2/projects/{projectKey}/ai-configs - GET /api/v2/projects/{projectKey}/ai-configs/{configKey} - Added support for the anyOf operator when using the tags filter at GET /api/v2/projects/{projectKey}/views - Added new usage endpoints - GET /api/v2/usage/observability/metrics - GET /api/v2/usage/vega-ai ### Changed - Updated Views (beta) API to support flags and segments as resource types. Removed aiConfigs and metrics from resourceType enum values and expand options for all Views endpoints. - Added optional customParameters field to AI tools endpoints for storing custom metadata and configuration. This field is available in: - GET /api/v2/projects/{projectKey}/ai-tools - GET /api/v2/projects/{projectKey}/ai-tools/{toolKey} - POST /api/v2/projects/{projectKey}/ai-tools - PATCH /api/v2/projects/{projectKey}/ai-tools/{toolKey} ### Removed - Removed environmentId query parameter from GET /api/v2/projects/{projectKey}/views/{viewKey}/linked/{resourceType}. The backend now resolves segment filters across all linked environments automatically.

v21.0.0

Added

• Added new endpoints for agent graphs, which represent directed graphs of AI Configs for agent workflows.

  • GET /api/v2/projects/{projectKey}/agent-graphs/{graphKey}
  • PATCH /api/v2/projects/{projectKey}/agent-graphs/{graphKey}
  • DELETE /api/v2/projects/{projectKey}/agent-graphs/{graphKey}

• Added evaluationMetricKey and isInverted to AI Configs endpoints:

  • GET /api/v2/projects/{projectKey}/ai-configs/{configKey} - returns these fields in response
  • POST /api/v2/projects/{projectKey}/ai-configs - accepts these fields in request body
  • PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey} - accepts these fields in request body
  • Deprecated evaluationMetricKeys in GET endpoints in response to this

• Added flagPurpose to POST /api/v2/metrics/{projectKey}, GET /api/v2/metrics/{projectKey}/{metricKey}, PATCH /api/v2/metrics/{projectKey}/{metricKey}

• Added new semantic patch instruction updateDescription for updating the description of approval requests

• Added releasePolicies and releasePolicyCount expandable properties to metric group responses. These fields are feature-flagged and will appear in the following endpoints when the enable-metric-group-release-policy-connections flag is enabled:

  • GET /api/v2/projects/{projectKey}/metric-groups
  • POST /api/v2/projects/{projectKey}/metric-groups
  • GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}
  • PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}

Changed

• Removed the beta tag from AI Configs, AI tools, and model configs APIs. These endpoints no longer require the LD-API-Version: beta header.
• All non-beta requests now include the LD-API-Version: 20240415 header by default. This default header value means that requests will use the API version corresponding to the appropriate OpenAPI spec rather than the authentication token's API version.

Removed

• Removed the generation of the PHP and JavaScript client libraries.

Bug Fixes

v20.0.0

Added - Added support for the following to Release Policy endpoints: - Guarded Releases: - Using flagTagKeys as scopes - Assigning metricKeys, metricGroupKeys, stages, and rolloutContextKind to the Release Policy - Progressive Releases - Assigning stages and rolloutContextKind to the Release Policy - Added optional dryRun query parameter to the following endpoints to preview changes without persisting them: - PATCH /api/v2/flags/{projectKey}/{featureFlagKey} - PATCH /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} - Added new endpoints for agent graphs, which represent directed graphs of AI Configs for agent workflows. - POST /api/v2/projects/{projectKey}/agent-graphs - GET /api/v2/projects/{projectKey}/agent-graphs - Added optional disabled field to flag targeting rules. When true, the rule is stored but not evaluated by SDKs. This allows temporarily disabling rules without deleting them. - Added new semantic patch instructions for flag targeting rules: - disableRule: Disable a targeting rule by ID - enableRule: Enable a previously disabled targeting rule by ID - Added optional disabled field to flag targeting rules. When true, the rule is stored but not evaluated by SDKs. This allows temporarily disabling rules without deleting them. - Added new semantic patch instructions for flag targeting rules: - disableRule: Disable a targeting rule by ID - enableRule: Enable a previously disabled targeting rule by ID - Added new endpoints for MAU - GET /api/v2/usage/total-mau - GET /api/v2/usage/clientside-mau ### Changed - Changed covariateInfo and covariateId fields to be hidden from public documentation. These fields are now internal and feature-flagged. - Marked old MAU APIs as deprecated - GET /api/v2/usage/mau - GET /api/v2/usage/mau/bycategory

v19.0.0

Added - Added new endpoint for generating a trust policy to allow LaunchDarkly to assume the role and perform Data Export operations on AWS resources - POST /api/v2/destinations/projects/{projKey}/environments/{envKey}/generate-trust-policy ### Removed ### Changed - Added redshift destination kind to Destination and DestinationPost reps - Metric responses will now always include a data source key. - IterationRep status is now an enum with values not_started, running, stopped. - added constantCase to the case enum in namingConvention. ### Bug Fixes - Removed required annotation from Relay Auto Config fullKey property since this is only set by the API for some response types.

v18.1.0

Added

• Added tags field to experiment POST request as optional body field. Tags are an array of strings.

• Added tags field to experiment responses. For individual experiment GET requests (GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}), the tags field is now always included in the response. For list experiment GET requests (GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments), the tags field can be included by adding expand=tags to the query parameters.

Removed

Changed

Bug Fixes

v18.0.2

Added

• Added lastUsedInExperiment and lastUsedInGuardedRollout fields to metric group responses. These fields appear in the following endpoints:
  • GET /api/v2/projects/{projectKey}/metric-groups
  • POST /api/v2/projects/{projectKey}/metric-groups
  • GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}
  • PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}

Removed

Changed

• Made the messages field optional in the request body of POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations. Validation is now mode-dependent: completion/judge mode requires messages, while agent mode rejects messages.
• Removed the beta tag from PATCH /api/v2/members

v18.0.0

Added

• Added 'covarianceInfo' field to Iteration response to show details of the covariance file used for stratified sampling

• Added judgeConfiguration field to AI Config variations for attaching judge AI configs with sampling rates. This field is available in variation-related endpoints

• Added judgingConfigKeys field to AI Config judge variation responses to show which AI configs this judge is evaluating

• Added imageUrl field to experiment treatment response in TreatmentRep schema (feature flagged and hidden from public documentation). This field will appear in the following endpoints once the enable-experimentation-treatment-images feature flag is enabled:

  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}

• Moved selectors, URLs to a different part of the Metrics object (no changes visible to consumers)

• Added GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting endpoint

• Added PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting endpoint

• Added new AI tools endpoints for managing AI tools within a project:

  • POST /api/v2/projects/{projectKey}/ai-tools (Create AI tool)
  • GET /api/v2/projects/{projectKey}/ai-tools (List AI tools)
  • GET /api/v2/projects/{projectKey}/ai-tools/{toolKey} (Get AI tool)
  • PATCH /api/v2/projects/{projectKey}/ai-tools/{toolKey} (Update AI tool)
  • DELETE /api/v2/projects/{projectKey}/ai-tools/{toolKey} (Delete AI tool)

• Marked key as not required for POST /api/v2/api/v2/metrics/projects/{projectKey}/metric-groups. It is still required for funnel or standard groups, but can be omitted for guardrail groups.

• Added type guardrail to metric groups data model, and to POST /api/v2/api/v2/metrics/projects/{projectKey}/metric-groups and GET /api/v2/metrics/projects/{projectKey}/metric-groups filter

• Added new endpoint to update approval request settings PATCH /api/v2/approval-requests/projects/{projectKey}/settings

• Added new endpoint to retrieve approval request settings GET /api/v2/approval-requests/projects/{projectKey}/settings

• Added _id to AI Config variations models

• Added mode field to AI Config with enum values agent and completion (default: completion)

• Added instructions and description fields to AI Config variations

• Added judge mode to AI Config for evaluation and assessment use cases

• Added conditional API behavior for AI Config variations based on mode: agent mode returns instructions/description and excludes messages, completion mode returns messages and excludes instructions/description

• Added new fields to input request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments endpoint

  • type
  • reallocationFrequencyMillis

• Added new fields to Experiment response

  • reallocationFrequencyMillis
  • updatedAt
  • version

• Added new fields to input request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations

  • type
  • reallocationFrequencyMillis

• Added new fields to the Iteration response

  • reallocationFrequencyMillis
  • updatedAt
  • version

• Added new endpoints to manage restricting AI models

  • POST /api/v2/projects/{projectKey}/ai-configs/model-configs/restricted
  • DELETE /api/v2/projects/{projectKey}/ai-configs/model-configs/restricted

• Added the isRestricted property to the AI model configs response to indicate model restriction status

• Added the filters property to the Metric response

• Added the comment property to the AI Configs Variation to document changes in each version

• Added optional isFlagOn boolean parameter to flag creation API to allow automatic flag activation across all environments

• Added aiConfig field to approval-request response

• Added optional audience.releaseGuardianConfiguration.metrics field of type MeasuredRolloutMetric to the input request body of PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}.

• Added new field to input request body of POST /api/v2/metrics/{projectKey}

  • filters

• Added an optional dataSource property to the Metric endpoint requests and responses to support warehouse native metrics

• Added observability usage endpoints

  • GET /api/v2/usage/observability/sessions
  • GET /api/v2/usage/observability/errors
  • GET /api/v2/usage/observability/logs
  • GET /api/v2/usage/observability/traces

• Added bigquery and databricks destination kinds to Destination and DestinationPost reps

• Added views endpoints for managing views within a project, and updated their descriptions

  • GET /api/v2/projects/{projectKey}/views
  • POST /api/v2/projects/{projectKey}/views
  • GET /api/v2/projects/{projectKey}/views/{viewKey}
  • DELETE /api/v2/projects/{projectKey}/views/{viewKey}
  • PATCH /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}

• Added documentation for existing possible 409 response from PUT /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{contextKind}/{contextKey}/flags/{featureFlagKey}

• Added archived metrics support with new fields and lifecycle state filtering:

  • Added archived (boolean) and archivedAt (timestamp) fields to Metric responses
  • Added lifecycleState filter parameter to GET /api/v2/metrics/{projectKey} endpoint using syntax filter=lifecycleState equals active or filter=lifecycleState equals archived (defaults to active metrics when no filter is provided)
  • Added support for PATCH /api/v2/metrics/{projectKey}/{metricKey} to update archived status
  • Added business logic validation to prevent archiving metrics in active experiments, rollouts, or groups
  • Added UpdateMetricArchived RBAC action for controlling archive permissions

• GET /api/v2/usage/service-connections

  • Added optional connectionType string parameter
  • Added optional relayVersion string parameter
  • Added optional sdkName string parameter
  • Added optional sdkVersion string parameter
  • Added optional sdkType string parameter
  • Added optional aggregationType string parameter
  • Added optional granularity string parameter
  • Added optional groupBy string parameter

• GET /api/v2/usage/data-export-events

  • Added optional eventKind string parameter
  • Added optional aggregationType string parameter
  • Added optional granularity string parameter
  • Added optional groupBy string parameter

• GET /api/v2/usage/experimentation-keys

  • Added optional experimentId string parameter
  • Added optional aggregationType string parameter
  • Added optional granularity string parameter
  • Added optional groupBy string parameter

• GET /internal/comments

• POST /internal/comments

• DELETE /internal/comments

• Added _version field to MetricListingRep for optimistic locking support in metric archive/restore operations

• Added activeExperimentCount field to MetricListingRep to show the number of active experiments using the metric

• Added activeGuardedRolloutCount field to MetricListingRep to show the number of active guarded rollouts using the metric

• Added GET /api/v2/usage/experimentation-events endpoint

• Added lastUsedInExperiment field to MetricRep to show the most recent experiment that used this metric (uses DependentExperimentRep type with fields: _links, creationDate, environmentId, environmentKey, key, name, archivedDate)

• Added lastUsedInGuardedRollout field to MetricRep to show the most recent guarded rollout that used this metric (uses DependentMeasuredRolloutRep type with fields: _id, _links, creationDate, environmentKey, environmentName, flagKey, flagName, status)

• Added lastUsedInEntity expand parameter to GET /api/v2/metrics/{projectKey}/{metricKey} endpoint

• Added new release policies beta endpoints:

• GET /api/v2/projects/{projectKey}/release-policies

• POST /api/v2/projects/{projectKey}/release-policies

• PUT /api/v2/projects/{projectKey}/release-policies

• PUT /api/v2/projects/{projectKey}/release-policies/{policyId}

• DELETE /api/v2/projects/{projectKey}/release-policies/{policyId}

• Added new creationConfig field to integration approval conditions on custom workflow rep to support the use of Custom Approvals

• GET /api/v2/usage/clientside-contexts

• GET /api/v2/usage/serverside-contexts

• GET /api/v2/usage/total-contexts

• Added eventKey field to the MetricV2Rep, MetricInGroupRep, and DependentMetricOrMetricGroupRep to expose the event key sent with custom metrics

• Added TotalConnectionsCount, TotalActiveConnectionsCount to MetricGroupRepExpandableProperties to show total connections and total activ...

v17.2.0

Added

• Added a new maintainerId field to the input request body of the POST /api/v2/metrics/{projectKey} endpoint
• Added a new resourceCategory field to the rep returned by custom roles endpoints and the custom role post body
• Added new _presetBundleVersion and _presetStatements fields to the rep returned by custom roles endpoints
• Added new query params, aggregationType and contextKind, to the GET /api/v2/usage/mau endpoint
• Added a new assignedTo expand parameter to GET /api/v2/roles and GET /api/v2/roles/{customRoleKey}
• Added fifteen new AI Configs (beta) endpoints for working with AI Configs, AI Config variations, and AI model configs
• Added documentation for the roleAttributes field and expand query parameter on the following endpoints:
  • GET /api/v2/members
  • GET /api/v2/members/{memberId}
  • GET /api/v2/teams
  • GET /api/v2/teams/{teamKey}
• Added documentation for patching the roleAttributes field on the PATCH /api/v2/teams/{teamKey} endpoint
• Added a new category field to the Metric response.
• Added new public endpoints for working with announcements:
  • GET /api/v2/announcements
  • POST /api/v2/announcements
  • PATCH /api/v2/announcements/{announcementId}
  • DELETE /api/v2/announcements/{announcementId}
• Added a new 'sort' query parameter to GET /api/v2/metric-groups/{projectKey}
• Updated the 'filter' query parameter of GET /api/v2/metric-groups/{projectKey} to include 'kind' as a valid option
• Added new satisfactionRating field to AI Configs metrics endpoints.
• Added new costPerInputToken and costPerInputToken fields to AI Configs Models.
• Added new cost metrics to AI Configs Metrics.
• Added new endpoint for generating an RSA key pair in order to create a new data warehouse destination
  • POST /api/v2/destinations/generate-warehouse-destination-key-pair

Removed

• Removed legacy experiment results endpoint GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}}
• Removed obsolete isActive field from endpoint POST /api/v2/metrics/{projectKey}

Changed

• Updated the Data Export destination endpoints to include a new destination kind
• Expose waitOnApprovals request parameter on POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports
• Updated the ApprovalRequestResponse type to optionally include resourceKind
• Removed the beta tag from the following endpoints
  • POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports
  • GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID}
  • POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports
  • GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID}
• Make environments optional on :
  • GET /api/v2/flags/{projectKey} (List flags)
  • POST /api/v2/flags/{projectKey} (Create flag)
  • GET /api/v2/flags/{projectKey}/{featureFlagKey} (Get flag)
  • PATCH /api/v2/flags/{projectKey}/{featureFlagKey} (Patch flag)
  • POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy (Copy flag)
• Added a list of valid values to the Import type returned by the GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} endpoint

v17.1.0

Added

• Added a roleAttributes field to the POST /api/v2/teams endpoint (Create team)
• Updated the request body type on PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
• Added new endpoints for working with integration configurations:
  • POST /api/v2/integration-configurations/keys/{integrationKey} (Create integration configuration)
  • GET /api/v2/integration-configurations/keys/{integrationKey} (Get all configurations for the integration)
  • GET /api/v2/integration-configurations/{integrationConfigurationId} (Get an integration configuration)
  • PATCH /api/v2/integration-configurations/{integrationConfigurationId} (Update integration configuration)
  • DELETE /api/v2/integration-configurations/{integrationConfigurationId} (Delete integration configuration)
• Added the new endpoint PATCH /api/v2/approval-requests/{id}
• Added a new endpoint in beta PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
• Expose roleAttributes on the Team type
• Expose totalCount in paginated roles API response

Removed

• Removed the unused bakeTimeDurationMs field from endpoints that return release and release pipeline details. These endpoints are currently in beta.
• Removed the beta endpoint PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}

Changed

• Updated environment in the following beta endpoints to no longer be required, in order to account for deleted environments:
  • GET /api/v2/flags/{projectKey}/{flagKey}/release
  • PATCH /api/v2/flags/{projectKey}/{flagKey}/release
  • PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release
  • PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}
  • GET /api/v2/projects/{projectKey}/release-pipelines
  • POST /api/v2/projects/{projectKey}/release-pipelines
  • GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
  • PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
• Renamed the /api/v2/integration-capabilities/big-segment-store endpoints to use the Persistent store integrations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints:
  • GET /api/v2/integration-capabilities/big-segment-store (List all big segment store integrations)
  • POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey} (Create big segment store integration)
  • GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Get big segment store integration by ID)
  • PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Update big segment store integration)
  • DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Delete big segment store integration)
• Renamed the /api/v2/integration-capabilities/flag-import endpoints to use the Flag import configurations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints:
  • GET /api/v2/integration-capabilities/flag-import (List all flag import configurations)
  • POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} (Create a flag import configuration)
  • GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Get a single flag import configuration)
  • PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Update a flag import configuration)
  • DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Delete a flag import configuration)
  • POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger (Trigger a single flag import run)
• Updated the operation id and summary field definitions for the PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} endpoint
• Updated items in /api/v2/roles response body to be required
• Updated items in /api/v2/teams response body to be required
• Added the property resourceApprovalSettings in the environment type
• Updated instructions[].value property in the PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} endpoint to be a 64 bit integer