Skip to content

fix(api): note api key in header user #79

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
jefflembeck merged 1 commit into from
Feb 7, 2023
Merged

fix(api): note api key in header user #79

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
2 changes: 2 additions & 0 deletions src/api/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ You can pass your API key along with tests requests by using the `k` parameter.
https://www.webpagetest.org/runtest.php?url={your_domain}&k={your_api_key}
```

If you prefer, instead of passing the `k` parameter, you may pass the request header `X-WPT-API-KEY`

::: warning
Your API keys are directly tied to your account, so be sure to keep them secure. Avoid sharing them in any public area, such as GitHub or client-side code.
:::
Expand Down