docs(netbox): clarify v1/v2 API token header formats - #46
Merged
michaelelrom merged 3 commits intoJul 27, 2026
Conversation
The Integration Configuration section only showed the legacy Authorization: Token <token> example, which reads as the only supported format. NetBox 4.6+ issues v2 tokens by default, used as Authorization: Bearer <key>.<token> — the OpenAPI spec's tokenAuth securityScheme already documents both; the README didn't. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Clarifies that the Authorization scheme prefix (Bearer/Token) belongs inside the single tokenAuth.value field in Admin Essentials, not split out separately, with a worked example for each token version. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Already covered generically in the root README's Getting Started section. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Authorization: Token <token>, which reads as the only supported auth format.Authorization: Bearer <key>.<token>— v1 tokens (Authorization: Token <token>) are deprecated as of 4.6 and removed in 5.0.tokenAuthsecurityScheme description already documents both formats correctly; the README just never got updated to match.Test plan
tokenAuthsecurityScheme description inOpenAPIs/netbox-latest.json(already correct, used as the source for this wording)Authorization: Token <TOKEN>; v2 token showsAuthorization: Bearer nbt_<key>.<TOKEN>)