Platform

Storage API Configuration Endpoints without Branch in URL Are Deprecated

So that there can be a single way to work with configurations, we are deprecating endpoints without the branch ID in the URL.

Storage API Configuration Endpoints without Branch in URL Are Deprecated
Image source: Wikipedia

There are currently two ways to work with configurations in the default branch in Storage API. There are the old endpoints like:

/v2/storage/components/component_id/configs

Then there are the new endpoints that support branches:

/v2/storage/branch/branch_id/components/component_id/configs

We're aiming to have a single way to work with configurations, so we're deprecating the first endpoint without the branch ID in the URL.

To observe the same behavior as in the deprecated endpoint, you must call the endpoint with a branch and replace the branch_id parameter with the string default, which will be automatically replaced with your default branch ID when the request is handled.

So the example above would look like this:

/v2/storage/branch/default/components/component_id/configs

The old endpoints are used a lot, so we're deprecating them slowly. We plan to retire them completely in about 3–6 months. We continuously collect data about the endpoint's usage. When there is a significant drop in usage, we'll establish and publish the retirement date.