2021-02-25 16:01:36 +01:00
---
2022-01-14 13:08:04 +01:00
title: How to use the Admin API
2021-02-25 16:01:36 +01:00
---
2024-10-01 11:33:50 +02:00
This guide explains the steps required to getting access to and using the Admin API.
2021-02-25 16:01:36 +01:00
2021-06-04 11:17:15 +02:00
## Step 1: Create API token {#step-1-create-api-token}
2021-02-25 16:01:36 +01:00
refactor: move docs into new structure / fix links for SEO (#2416)
## 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.
2022-11-22 10:05:30 +01:00
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.
2021-02-25 16:01:36 +01:00
2021-08-30 09:36:26 +02:00
Please note that it may take up to 60 seconds for the new key to propagate to all Unleash instances due to eager caching.
2021-02-25 16:01:36 +01:00
2021-12-14 12:19:08 +01:00
:::note
2022-09-30 13:01:32 +02:00
2021-12-14 12:19:08 +01:00
If you need an API token to use in a client SDK you should create a "client token" as these have fewer access rights.
2022-09-30 13:01:32 +02:00
2021-12-14 12:19:08 +01:00
:::
2021-02-25 16:01:36 +01:00
2021-06-04 11:17:15 +02:00
## Step 2: Use Admin API {#step-2-use-admin-api}
2021-02-25 16:01:36 +01:00
2021-08-30 09:36:26 +02:00
Now that you have an access token with admin privileges we can use that to perform changes in our Unleash instance.
2021-02-25 16:01:36 +01:00
2024-05-24 12:28:49 +02:00
In the example below we will use the [Unleash Admin API ](/reference/api/legacy/unleash/admin/features.md ) to enable the “Demo” feature flag using curl.
2021-02-25 16:01:36 +01:00
```sh
2021-12-14 12:19:08 +01:00
curl -X POST -H "Content-Type: application/json" \
2022-10-13 11:02:04 +02:00
-H "Authorization: some-token" \
2021-12-14 12:19:08 +01:00
https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
2021-02-25 16:01:36 +01:00
```
2024-10-08 12:11:05 +02:00
**Great success!** We have now enabled the feature flag. We can also verify that it was actually changed by the API user by navigating to [Event Log ](/reference/events#event-log ) and filtering events for this feature flag.
2021-05-18 11:19:33 +02:00
2024-10-08 12:11:05 +02:00
![Feature flag events showing that it was last updated by "admin-api". ](/img/api_access_history.png )
2021-02-25 16:01:36 +01:00
2021-06-04 11:17:15 +02:00
## API overview {#api-overview}
2021-02-25 16:01:36 +01:00
refactor: move docs into new structure / fix links for SEO (#2416)
## 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.
2022-11-22 10:05:30 +01:00
You can find the full documentation on everything the Unleash API supports in the [Unleash API documentation ](/reference/api/legacy/unleash/admin/features.md ).