mirror of
https://github.com/Unleash/unleash.git
synced 2024-11-01 19:07:38 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
38 lines
1.9 KiB
Markdown
38 lines
1.9 KiB
Markdown
---
|
|
title: How to use the Admin API
|
|
---
|
|
|
|
It is possible to integrate directly with the Admin API. In this guide we will explain all the steps to set it up.
|
|
|
|
## Step 1: Create API token {#step-1-create-api-token}
|
|
|
|
You'll need either an [admin token](../reference/api-tokens-and-client-keys.mdx#admin-tokens) or a [personal access token](../reference/api-tokens-and-client-keys.mdx#personal-access-tokens) for this to work. To create one, follow the steps in the [_how to create API tokens_](../how-to/how-to-create-api-tokens.mdx) guide or the [_how to create personal access tokens_](./how-to-create-personal-access-tokens.mdx) guide, respectively.
|
|
|
|
Please note that it may take up to 60 seconds for the new key to propagate to all Unleash instances due to eager caching.
|
|
|
|
:::note
|
|
|
|
If you need an API token to use in a client SDK you should create a "client token" as these have fewer access rights.
|
|
|
|
:::
|
|
|
|
## Step 2: Use Admin API {#step-2-use-admin-api}
|
|
|
|
Now that you have an access token with admin privileges we can use that to perform changes in our Unleash instance.
|
|
|
|
In the example below we will use the [Unleash Admin API](/reference/api/legacy/unleash/admin/features.md) to enable the “Demo” feature toggle using curl.
|
|
|
|
```sh
|
|
curl -X POST -H "Content-Type: application/json" \
|
|
-H "Authorization: some-token" \
|
|
https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
|
|
```
|
|
|
|
**Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the Event log (history) for this feature toggle.
|
|
|
|
|
|
|
|
## API overview {#api-overview}
|
|
|
|
You can find the full documentation on everything the Unleash API supports in the [Unleash API documentation](/reference/api/legacy/unleash/admin/features.md).
|