mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-16 00:06:40 +01:00
51c7ea053e
* Update api_access_history.png * updating images in - How to capture impression data * Update Quickstart image * Update images: How to add strategy constraints * Update images: How to create a feature toggle * Update images: How to define custom context fields * Update images: How to use custom activation strategies * Update images: How to schedule feature releases * Update images: How to add new users to your Unleash instance * Update images: How to create and assign custom project roles * Update images: How to add SSO with OpenId Connect * Update images: How to add SSO with SAML 2.0 Okta * Update images: Slack * Update images: Activation Strategies * Update images: Archived toggles * Update images: The audit log * Update images: Impression data * Update images: Custom Activation Strategies * Update images: Environments * Update images: Feature Toggle Types * Update images: Feature Toggle Variants * Update images: Projects * Update images: Segments * Update images: Stickiness * Update images: Strategy Constraints * Update images: Technical Debt * Update images: Unleash Context * Update images: Unleash introductory overview * Update images: Unleash introductory overview * docs: replace strategy constraints step 2 img * Update website/docs/how-to/how-to-add-strategy-constraints.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * change text request * Updating docs text to match the screenshots * Docs: change audit log to event log and add redirects * Docs: update "archive" page with deletion info * Docs: update constraints how to * Docs: minor tech debt doc fixes * docs-update-images-set1: update overview page * Apply suggestions from code review Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/quickstart.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/user-management.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/user-management.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Activation strategy update * Apply suggestions from code review * Update delete-archive img * Fix prettier formatting for admonitions * Update website/docs/user_guide/environments.md * Update website/docs/user_guide/projects.md Co-authored-by: Tymoteusz Czech <tymek+gpg@getunleash.ai> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
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 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](../api/admin/features).
|