Skip to content

docs: document API key authentication on API specs page #447

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
grizz merged 2 commits into from
Aug 15, 2026
Merged

docs: document API key authentication on API specs page #447

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d212597
docs: document API key authentication on API specs page
SAY-5 Jul 26, 2026
330cfd8
additional update, no more basic auth
grizz Aug 15, 2026
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
10 changes: 9 additions & 1 deletion docs/api_specs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,15 @@ JSON

#### Authentication

- Basic HTTP authorization
- API key, sent in the `Authorization` header as `Authorization: Api-Key <KEY>`

An API key is required for all authenticated requests, including all writes
(`POST`, `PUT`, `PATCH`, `DELETE`). See our [guide on API keys](/howto/api_keys/)
for how to create and use one, and [querying with the PeeringDB
API](/howto/search/#querying-with-the-peeringdb-api) for copy/paste examples.

Basic HTTP authorization is deprecated and is no longer accepted. Authenticated
requests that use it are rejected with a `403`.

In order to access the API as a guest simply omit any authentication

Expand Down