starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Swagger API documentation forgets the "Token" in authorization header #11742

New Issue
Open
opened 2025-12-29 21:49:21 +01:00 by adam · 2 comments
adam commented 2025-12-29 21:49:21 +01:00
Owner
Copy Link

Originally created by @PenelopeFudd on GitHub (Oct 17, 2025).

NetBox Edition

NetBox Community

NetBox Version

v4.2.6

Python Version

3.10

Steps to Reproduce

  1. Go to Swagger API documentation console https://netbox.example.org/api/schema/swagger-ui/
  2. Authenticate with tokenAuth (apikey) -- and fail to include "Token " at the front because the sentence Token-based authentication with required prefix "Token" was not understood.
  3. Execute an example, like /api/status/ -- it works because of browser session cookies.
  4. Note that the curl example has -H 'Authorization: 111222333444555'
  5. Note that actually copying and running the curl example fails with {"detail":"Authentication credentials were not provided."}

Expected Behavior

The example shown on the screen should work when copied and pasted to a command line.

It's possible that the generated API definition used by swagger can't be made to validate the user inputted token.

Observed Behavior

The example shown doesn't work, but appears to work in the swagger UI.

Originally created by @PenelopeFudd on GitHub (Oct 17, 2025). ### NetBox Edition NetBox Community ### NetBox Version v4.2.6 ### Python Version 3.10 ### Steps to Reproduce 1. Go to Swagger API documentation console https://netbox.example.org/api/schema/swagger-ui/ 2. Authenticate with tokenAuth (apikey) -- and fail to include "Token " at the front because the sentence `Token-based authentication with required prefix "Token"` was not understood. 3. Execute an example, like /api/status/ -- it works because of browser session cookies. 4. Note that the curl example has `-H 'Authorization: 111222333444555'` 5. Note that actually copying and running the curl example fails with `{"detail":"Authentication credentials were not provided."}` ### Expected Behavior The example shown on the screen should work when copied and pasted to a command line. It's possible that the generated API definition used by swagger can't be made to validate the user inputted token. ### Observed Behavior The example shown doesn't work, but appears to work in the swagger UI.
adam added the type: bugstatus: needs ownernetboxseverity: low labels 2025-12-29 21:49:21 +01:00
adam commented 2025-12-29 21:49:21 +01:00
Author
Owner
Copy Link

@PenelopeFudd commented on GitHub (Oct 17, 2025):

It's possible this has been fixed in a more recent version of NetBox; please disregard if so.

Another possible solution is to modify the API so that the error message in this particular case could be:

{"detail":"Authentication credentials need to be formatted like this: \"Authorization: Token xxxxxxxxx\"."}
@PenelopeFudd commented on GitHub (Oct 17, 2025): It's possible this has been fixed in a more recent version of NetBox; please disregard if so. Another possible solution is to modify the API so that the error message in this particular case could be: ``` {"detail":"Authentication credentials need to be formatted like this: \"Authorization: Token xxxxxxxxx\"."} ```
adam commented 2025-12-29 21:49:22 +01:00
Author
Owner
Copy Link

@PenelopeFudd commented on GitHub (Oct 17, 2025):

Also, if an api request comes in with a valid cookie but an invalid authorization header (or vice versa) reject the request with a good error message.

@PenelopeFudd commented on GitHub (Oct 17, 2025): Also, if an api request comes in with a valid cookie but an invalid authorization header (or vice versa) reject the request with a good error message.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label netbox severity: low status: needs owner type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11742
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?