1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/advanced/api_access.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

---
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.
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-12-14 12:19:08 +01:00
:::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}
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-09-22 12:29:58 +02:00
In the example below we will use the [Unleash Admin API](../api/admin/features) to enable the “Demo” feature toggle using curl.
```sh
2021-12-14 12:19:08 +01:00
curl -X POST -H "Content-Type: application/json" \
-H "Authorization: admintoken" \
https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
```
docs: update images using latest UI screenshots (#1992) * 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>
2022-09-14 09:59:18 +02:00
**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.
2021-12-14 12:19:08 +01:00
![A feature toggle's event log showing that it was last updated by \"admin-api\".](/img/api_access_history.png)
## API overview {#api-overview}
You can find the full documentation on everything the Unleash API supports in the [Unleash API documentation](../api/admin/features).