diff --git a/website/docs/api/admin/feature-toggles-api.md b/website/docs/api/admin/feature-toggles-api.md index 948a795960c..6bca9852522 100644 --- a/website/docs/api/admin/feature-toggles-api.md +++ b/website/docs/api/admin/feature-toggles-api.md @@ -3,11 +3,23 @@ id: features title: /api/admin/features --- -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token. +:::caution Deprecation notice +This API was deprecated as part of the v4.3 release and will be removed in v5.0. See [the project-based API (/api/admin/projects/:projectId)](./feature-toggles-api-v2.md) instead. +::: -**This API was deprecated as part of the v4.3 release and will be removed in v5.0. See [/api/admin/projects/:projectId](/api/admin/feature-toggles-v2) instead.** + -### Fetching Feature Toggles {#fetching-feature-toggles} + +:::info +In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an **admin** token](/user_guide/api-token) and add an Authorization header using the token. +::: + + +## Fetching Feature Toggles {#fetching-feature-toggles} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to fetch all toggles](./feature-toggles-api-v2.md#fetching-toggles) instead. +::: `GET: http://unleash.host.com/api/admin/features` @@ -75,7 +87,7 @@ This endpoint is the one all admin ui should use to fetch all available feature } ``` -#### Filter feature toggles {#filter-feature-toggles} +### Filter feature toggles {#filter-feature-toggles} Supports three params for now @@ -95,7 +107,11 @@ To filter for any feature belonging to project `myproject` use Response format is the same as `api/admin/features` -### Fetch specific feature toggle {#fetch-specific-feature-toggle} +## Fetch specific feature toggle {#fetch-specific-feature-toggle} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to fetch specific toggles](./feature-toggles-api-v2.md#get-toggle) instead. +::: `GET: http://unleash.host.com/api/admin/features/:featureName` @@ -119,7 +135,12 @@ Used to fetch details about a specific featureToggle. This is mostly provded to } ``` -### Create a new Feature Toggle {#create-a-new-feature-toggle} +## Create a new Feature Toggle {#create-a-new-feature-toggle} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to create feature toggles](./feature-toggles-api-v2.md#create-toggle) instead. +::: + `POST: http://unleash.host.com/api/admin/features/` @@ -150,7 +171,12 @@ Used by the admin-dashboard to create a new feature toggles. Returns 200-response if the feature toggle was created successfully. -### Update a Feature Toggle {#update-a-feature-toggle} +## Update a Feature Toggle {#update-a-feature-toggle} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to update a feature toggle](./feature-toggles-api-v2.md#update-toggle) instead. +::: + `PUT: http://unleash.host.com/api/admin/features/:toggleName` @@ -177,7 +203,13 @@ Used by the admin dashboard to update a feature toggles. The name has to match a Returns 200-response if the feature toggle was updated successfully. -### Tag a Feature Toggle {#tag-a-feature-toggle} +## Tag a Feature Toggle {#tag-a-feature-toggle} + +:::caution Deprecation notice + +This endpoint is deprecated. Please use the [project-based endpoint to tag a feature toggle](./feature-toggles-api-v2.md#fetching-toggles) instead. +::: + `POST https://unleash.host.com/api/admin/features/:featureName/tags` @@ -203,7 +235,13 @@ If the tuple (type, value) does not already exist, it will be added to the list - Returns _404-NOT-FOUND_ if the `type` was not found -### Remove a tag from a Feature Toggle {#remove-a-tag-from-a-feature-toggle} +## Remove a tag from a Feature Toggle {#remove-a-tag-from-a-feature-toggle} + +:::caution Deprecation notice + +This endpoint is deprecated. Please use the [project-based endpoint to remove tags from a toggle](./feature-toggles-api-v2.md#fetching-toggles) instead. +::: + `DELETE https://unleash.host.com/api/admin/features/:featureName/tags/:type/:value` @@ -218,13 +256,23 @@ Removes the specified tag from the `(type, value)` tuple from the Feature Toggle - Returns 404 if the tag does not exist - Returns 500 if the database could not be reached -### Archive a Feature Toggle {#archive-a-feature-toggle} +## Archive a Feature Toggle {#archive-a-feature-toggle} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to archive toggles](./feature-toggles-api-v2.md#archive-toggle) instead. +::: + `DELETE: http://unleash.host.com/api/admin/features/:toggleName` Used to archive a feature toggle. A feature toggle can never be totally be deleted, but can be archived. This is a design decision to make sure that a old feature toggle does not suddenly reappear because someone else is re-using the same name. -### Enable a Feature Toggle {#enable-a-feature-toggle} +## Enable a Feature Toggle {#enable-a-feature-toggle} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to enable feature toggles](./feature-toggles-api-v2.md#where?) instead. +::: + `POST: http://unleash.host.com/api/admin/features/:featureName/toggle/on` @@ -253,7 +301,11 @@ None } ``` -### Disable a Feature Toggle {#disable-a-feature-toggle} +## Disable a Feature Toggle {#disable-a-feature-toggle} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to disable feature toggles](./feature-toggles-api-v2.md#where?) instead. +::: `POST: http://unleash.host.com/api/admin/features/:featureName/toggle/off` @@ -283,7 +335,12 @@ None } ``` -### Mark a Feature Toggle as "stale" {#mark-a-feature-toggle-as-stale} +## Mark a Feature Toggle as "stale" {#mark-a-feature-toggle-as-stale} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to patch a feature toggle and mark it as stale](./feature-toggles-api-v2.md#patch-toggle) instead. +::: + `POST: http://unleash.host.com/api/admin/features/:featureName/stale/on` @@ -313,7 +370,11 @@ None } ``` -### Mark a Feature Toggle as "active" {#mark-a-feature-toggle-as-active} +## Mark a Feature Toggle as "active" {#mark-a-feature-toggle-as-active} + +:::caution Deprecation notice +This endpoint is deprecated. Please use the [project-based endpoint to patch a feature toggle and mark it as not stale](./feature-toggles-api-v2.md#patch-toggle) instead. +::: `POST: http://unleash.host.com/api/admin/features/:featureName/stale/off`