mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
9c7eadded0
Also adds a caution admonition to the legacy doc index page
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
---
|
|
id: index
|
|
title: Legacy API Documentation
|
|
---
|
|
|
|
:::caution
|
|
|
|
The docs in this category are legacy documentation. You should prefer to use the [Unleash OpenAPI docs](/reference/api/unleash) instead whenever possible.
|
|
|
|
:::
|
|
|
|
## Client API {#client-api}
|
|
|
|
This describes the API provided to unleash-clients.
|
|
|
|
Since v4.0.0 all operations require an [API token](/how-to/how-to-create-api-tokens.mdx) with `Client` level access.
|
|
|
|
With versions earlier than v4.0.0 and `insecure` authentication no authentication is required.
|
|
|
|
- [Feature Toggles API](./client/features.md)
|
|
- [Register API](./client/register.md)
|
|
- [Metrics API](./client/metrics.md)
|
|
|
|
## Admin API (internal) {#admin-api-internal}
|
|
|
|
The internal API used by the Admin UI (unleash-frontend). Since v4.0.0 all operations require an [API token](/how-to/how-to-create-api-tokens) with `Admin` level access:
|
|
|
|
With versions earlier than v4.0.0 and `insecure` authentication Basic Auth (with curl `-u myemail@test.com:`) is enough.
|
|
|
|
- [Events API](./admin/events.md)
|
|
- [Feature Toggles API](./admin/features.md)
|
|
- [Metrics API](./admin/metrics.md)
|
|
- [Project API](./admin/projects.md)
|
|
- [Strategies API](./admin/strategies.md)
|
|
- [Tags API](./admin/tags.md)
|
|
|
|
## System API's {#system-apis}
|
|
|
|
- [Internal Backstage Prometheus API](./internal/prometheus.md)
|
|
|
|
### Content-Type {#contenttype}
|
|
|
|
All endpoints require `application/json` as content type, so if you're using curl remember to add
|
|
|
|
```bash
|
|
-H "Content-Type: application/json"
|
|
```
|