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

Return server error messages as JSON when handling REST API requests #4241

New Issue
Closed
opened 2025-12-29 18:34:11 +01:00 by adam · 0 comments
adam commented 2025-12-29 18:34:11 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Nov 3, 2020).

Originally assigned to: @jeremystretch on GitHub.

Environment

  • Python version: 3.6.9
  • NetBox version: 2.9.8

Proposed Functionality

When a REST API request triggers an unhandled exception, the response should convey the error message and any other pertinent information as JSON-formatted data.

Use Case

When an unhandled exception occurs during the processing of a request (and debugging is disabled), NetBox returns a human-friendly HTML page citing the error message and other information. While helpful to humans, this content is not appropriate in a REST API response, which should contain only JSON data. For example:

{
    "exception": "ValueError",
    "error_message": "Invalid something something",
    "python_version": "3.6.9",
    "netbox_version": "2.9.8"
}

The is_api_request() utility function may be helpful for discerning REST API requests from web UI requests.

Database Changes

None

External Dependencies

None

Originally created by @jeremystretch on GitHub (Nov 3, 2020). Originally assigned to: @jeremystretch on GitHub. ### Environment * Python version: 3.6.9 * NetBox version: 2.9.8 ### Proposed Functionality When a REST API request triggers an unhandled exception, the response should convey the error message and any other pertinent information as JSON-formatted data. ### Use Case When an unhandled exception occurs during the processing of a request (and debugging is disabled), NetBox returns a human-friendly HTML page citing the error message and other information. While helpful to humans, this content is not appropriate in a REST API response, which should contain only JSON data. For example: ```json { "exception": "ValueError", "error_message": "Invalid something something", "python_version": "3.6.9", "netbox_version": "2.9.8" } ``` The `is_api_request()` utility function may be helpful for discerning REST API requests from web UI requests. ### Database Changes None ### External Dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 18:34:11 +01:00
adam closed this issue 2025-12-29 18:34:11 +01:00
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 status: accepted type: feature
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#4241
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?