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

4.0.2 API Docs Page Not Found #9703

New Issue
Closed
opened 2025-12-29 21:21:20 +01:00 by adam · 4 comments
adam commented 2025-12-29 21:21:20 +01:00
Owner
Copy Link

Originally created by @tgoodsell-tempus on GitHub (May 20, 2024).

Deployment Type

Self-hosted

NetBox Version

v4.0.2

Python Version

3.11

Steps to Reproduce

  1. View documentation stating Interactive REST API Docs located at /api/docs/: https://demo.netbox.dev/static/docs/rest-api/overview/#interactive-documentation
  2. Try to browse that location on a self hosted netbox instance while logged in as a super user.

Expected Behavior

Viewing the expected Interactive Documentation page.

Observed Behavior

Get a 404 - "The requested page does not exist" error.

Originally created by @tgoodsell-tempus on GitHub (May 20, 2024). ### Deployment Type Self-hosted ### NetBox Version v4.0.2 ### Python Version 3.11 ### Steps to Reproduce 1. View documentation stating Interactive REST API Docs located at `/api/docs/`: https://demo.netbox.dev/static/docs/rest-api/overview/#interactive-documentation 2. Try to browse that location on a self hosted netbox instance while logged in as a super user. ### Expected Behavior Viewing the expected Interactive Documentation page. ### Observed Behavior Get a 404 - "The requested page does not exist" error.
adam closed this issue 2025-12-29 21:21:20 +01:00
adam commented 2025-12-29 21:21:21 +01:00
Author
Owner
Copy Link

@tgoodsell-tempus commented on GitHub (May 20, 2024):

Based upon some references to it and my own use of the endpoint, maybe this is just a doc change to reference /api/schema/swagger-ui/ instead? Provided what was referred to in the original document effectively means this swagger doc.

@tgoodsell-tempus commented on GitHub (May 20, 2024): Based upon some references to it and my own use of the endpoint, maybe this is just a doc change to reference `/api/schema/swagger-ui/` instead? Provided what was referred to in the original document effectively means this swagger doc.
adam commented 2025-12-29 21:21:21 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (May 21, 2024):

@tgoodsell-tempus that could be something left over in static, what are you doing to navigate to that link? Did you follow this link from an old install of NetBox? The link for this should be at https://docs.netbox.dev/en/stable/integrations/rest-api/ which does work on both the demo and local install.

@arthanson commented on GitHub (May 21, 2024): @tgoodsell-tempus that could be something left over in static, what are you doing to navigate to that link? Did you follow this link from an old install of NetBox? The link for this should be at https://docs.netbox.dev/en/stable/integrations/rest-api/ which does work on both the demo and local install.
adam commented 2025-12-29 21:21:21 +01:00
Author
Owner
Copy Link

@tgoodsell-tempus commented on GitHub (May 21, 2024):

@arthanson Yes good callout, yes this is just a leftover from the static path for the docs, rather than the use of stable: https://demo.netbox.dev/static/docs/rest-api/overview/#interactive-documentation

In my case, it's likely it's just a "Googling" error, picking the wrong link of the two; for example:
Screenshot 2024-05-21 at 10 16 36 AM

@tgoodsell-tempus commented on GitHub (May 21, 2024): @arthanson Yes good callout, yes this is just a leftover from the `static` path for the docs, rather than the use of stable: https://demo.netbox.dev/static/docs/rest-api/overview/#interactive-documentation In my case, it's likely it's just a "Googling" error, picking the wrong link of the two; for example: ![Screenshot 2024-05-21 at 10 16 36 AM](https://github.com/netbox-community/netbox/assets/56050072/9e148a83-82a0-4c42-b66b-34287a372cb1)
adam commented 2025-12-29 21:21:22 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (May 21, 2024):

@tgoodsell-tempus I'll close this issue and create a housekeeping issue to cleanup old links on the demo instance. Thanks for alerting us to this.

@arthanson commented on GitHub (May 21, 2024): @tgoodsell-tempus I'll close this issue and create a housekeeping issue to cleanup old links on the demo instance. Thanks for alerting us to this.
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
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#9703
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?