Skip to content

docs: use the standard Bearer scheme for API access tokens #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshiste merged 1 commit into from
Sep 29, 2026
Merged

docs: use the standard Bearer scheme for API access tokens #219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions integrate-with-steadybit/api/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ curl -X 'POST' \
'https://platform.steadybit.com/api/access-tokens/v2' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: accessToken <admin-token>' \
-H 'Authorization: Bearer <admin-token>' \
-d '{
"name": "CI/CD access token",
"type": "TEAM",
Expand Down Expand Up @@ -120,7 +120,11 @@ We provide an [OpenAPI 3.0 Specification for the API](https://platform.steadybit

### Requests and Responses

All API requests require an access token, passed via the `Authorization` header in the format `Authorization: accessToken <token>`.
All API requests require an access token, passed via the `Authorization` header in the standard bearer format `Authorization: Bearer <token>`. HTTP clients, API tools, and generated SDKs support this format out of the box.

{% hint style="info" %}
The legacy format `Authorization: accessToken <token>` is still supported, so existing scripts and pipelines keep working. On-prem installations running an older platform version accept only the legacy format.
{% endhint %}

Where applicable, request and response bodies are JSON or YAML, depending on the `Content-Type` and `Accept` headers you send. Success or failure of an API call is expressed via the HTTP status code.

Expand All @@ -133,7 +137,7 @@ In this case, the `Retry-After` response header contains the number of seconds t
```bash
curl \
-v \
-H "Authorization: accessToken <token>"\
-H "Authorization: Bearer <token>"\
-H "Accept: application/json"\
https://platform.steadybit.com/api/<endpoint>
[...]
Expand All @@ -153,7 +157,7 @@ This is how you can create an experiment. The example uses YAML; JSON is support
curl \
-i \
-H 'Content-Type: application/x-yaml' \
-H 'Authorization: accessToken <token>' \
-H 'Authorization: Bearer <token>' \
https://platform.steadybit.com/api/experiments \
--data '
---
Expand Down Expand Up @@ -193,7 +197,7 @@ You can then run the experiment:
curl \
-i \
-X POST \
-H 'Authorization: accessToken <token>' \
-H 'Authorization: Bearer <token>' \
https://platform.steadybit.com/api/experiments/ADM-1/execute
```

Expand Down
Loading