REST API migration guide: 20220603 to 20240415
REST API migration guide: 20220603 to 20240415
REST API migration guide: 20220603 to 20240415
This topic explains changes in the 20240415 version of the LaunchDarkly REST API and how to migrate to that version.
The 20240415 REST API version includes breaking changes. We strongly recommend upgrading to the latest API version as soon as possible. All customers will be required to use version 20240415 as of January 1, 2027.
The 20220603 REST API version reaches its end of life on December 31, 2026
The 20220603 REST API version reaches its end of life on December 31, 2026. After this date, you will no longer be able to access version 20220603, and must upgrade to version 20240415.
Specifically, the 20240415 version:
These changes are focused on improving performance and stability of the API. There are two ways to upgrade to the latest API version:
Create a new access token and set it to use the latest version, 20240415. Replace all uses of your existing access token with this new token.
Update the LD-API-Version header in all of your requests to 20240415. Here’s how:
The following sections describe how to migrate your API access tokens, the details of the API changes, and how to work with the new version. You can find a summary of these changes under Versioning in the LaunchDarkly REST API documentation. This section also includes the End of Life (EOL) information for each REST API version. The 20220603 version has reached EOL as of April 15, 2025.
If you have questions or would like assistance during this transition, start a Support ticket.
This guide applies only to the LaunchDarkly REST APIs. No LaunchDarkly SDKs are being deprecated as part of the changes described in this guide.
To learn more about the differences between these offerings, read Comparing LaunchDarkly’s SDKs and REST API. To review information on currently supported LaunchDarkly SDK versions, read Supported versions.
When you create a new API access token, by default its version is now 20240415.
Only currently supported versions are available when you create new access tokens. However, you may have older API access tokens that are set to unsupported versions.
To upgrade your integration to use a new API version, you can either create a new access token, or explicitly set the LD-API-Version header in each request. We recommend that you set the API version header explicitly.
To use the new version, update your request header to include LD-API-Version: 20240415. For example:
We recommend that you set the API version header explicitly in any client or integration you build. Only rely on the access token API version during manual testing.
If you are using the LaunchDarkly REST API through one of our generated client libraries, upgrade to version 21.x or later to use the 20240415 version.
The following endpoints previously served unpaginated results, and now serve paginated results in version 20240415:
In each case, you can use the limit and offset query parameters to page through the results.
To page through the results, repeat each request, increasing the offset by the limit each time, until one of the following is true:
items array in the response is emptyoffset is greater than the totalCount in the response, if availableEach paginated endpoint includes a default page size, typically 20. You can customize this as needed using the limit query parameter.
For example, previously your request may have looked like:
Now, it should look like:
You should repeat this request, increasing the offset by the limit each time, until you find the result you are looking for, or have paged through all of the results.
In the 20240415 API version, the List access tokens endpoint is now paginated. It has a default page size of 25. The maximum for the limit query parameter is 1000.
In the 20240415 API version, the List account members endpoint no longer supports the accessCheck filter. Additionally, the maximum for the limit query parameter is now 1000.
In the 20240415 API version, the List custom roles endpoint is now paginated. It has a default page size of 20. The maximum for the limit query parameter is 1000.
In the 20240415 API version, the List feature flags endpoint is now paginated. It has a default page size of 20. The maximum for the limit query parameter is 100.
Additionally, the following filters are no longer available:
codeReferencescontextKindTargetedcontextKindsEvaluatedfollowerIdhasDataExporthasExperimentsegmentTargetedstatustargetingtargetingModifiedDate (sorting filter)The compare query parameter has also been removed.
Finally, the environments field is now only included in the response if the request is filtered by environment, using the env query parameter.
In the 20240415 API version, the List segments endpoint is now paginated. It has a default page size of 20. The maximum for the limit query parameter is 50.
In the 20240415 API version, the List teams endpoint no longer supports expanding the projects or roles fields in the response.
Additionally, the maximum for the limit query parameter is now 100.
In the 20240415 API version, the Get workflows endpoint is now paginated. It has a default page size of 20. The maximum for the limit query parameter is 200.
Additionally, the _conflicts field in the response is no longer available.
The Users API, Users (beta) API, and User settings API were deprecated in May 2023. Following the release of the 20240415 API version, these deprecated APIs are being removed completely.