mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
---
|
|
id: api_access
|
|
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}
|
|
|
|
Please refer to [_how to create API tokens_](../user_guide/api-token) on how to create an API token. You'll need a token with `Admin` level access for this to work.
|
|
|
|
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](../api/admin/features) to enable the “Demo” feature toggle using curl.
|
|
|
|
```sh
|
|
curl -X POST -H "Content-Type: application/json" \
|
|
-H "Authorization: admintoken" \
|
|
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 history (audit log) 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](../api/admin/features).
|