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

Add URL field on API responses that provides the NetBox UI URL to an object #9250

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

Originally created by @ITJamie on GitHub (Feb 14, 2024).

Originally assigned to: @arthanson on GitHub.

NetBox version

4.0.2

Feature type

New functionality

Proposed functionality

When using the Rest API the URL field on objects has direct API URLs.
It would be great if there was a display_url or ui_url to use when referencing the object in external tools.

Removing /api from the the existing url field on API response doesn't always work to get to a valid UI URL.

This could be an optional non-default field that could be requested if needed now that #15087 is possible.

examples of what this could look like:

VM API response:

{
    "id": 361,
    "url": "https://demo.netbox.dev/api/virtualization/virtual-machines/361/",
    "ui_url": "https://demo.netbox.dev/virtualization/virtual-machines/361/",
    "display": "vm1",
    "name": "vm1",
 <truncated>

VM Disk response:

{
    "id": 1,
    "url": "https://demo.netbox.dev/api/virtualization/virtual-disks/1/",
    "ui_url: "https://demo.netbox.dev/virtualization/disks/1/",
    "display": "disk1",
 <truncated>

Use case

When using the API sometimes we send slack alerts or emails for specific issues we find with data for a human to visit and interfact with / fix.

With most objects we can strip /api from the URL and give that URL to users, however not all objects follow that (e.g. virtual disks on VMs)

Example:

  • UI URL: http://netbox_instance/virtualization/disks/1/
  • API URL: http://netbox_instance/api/virtualization/virtual-disks/1/

Database changes

N/A

External dependencies

N/A

Originally created by @ITJamie on GitHub (Feb 14, 2024). Originally assigned to: @arthanson on GitHub. ### NetBox version 4.0.2 ### Feature type New functionality ### Proposed functionality When using the Rest API the URL field on objects has direct API URLs. It would be great if there was a `display_url` or `ui_url` to use when referencing the object in external tools. Removing `/api` from the the existing `url` field on API response doesn't always work to get to a valid UI URL. This could be an optional non-default field that could be requested if needed now that #15087 is possible. examples of what this could look like: VM API response: ``` { "id": 361, "url": "https://demo.netbox.dev/api/virtualization/virtual-machines/361/", "ui_url": "https://demo.netbox.dev/virtualization/virtual-machines/361/", "display": "vm1", "name": "vm1", <truncated> ``` VM Disk response: ``` { "id": 1, "url": "https://demo.netbox.dev/api/virtualization/virtual-disks/1/", "ui_url: "https://demo.netbox.dev/virtualization/disks/1/", "display": "disk1", <truncated> ``` ### Use case When using the API sometimes we send slack alerts or emails for specific issues we find with data for a human to visit and interfact with / fix. With most objects we can strip `/api` from the URL and give that URL to users, however not all objects follow that (e.g. virtual disks on VMs) Example: - UI URL: `http://netbox_instance/virtualization/disks/1/` - API URL: `http://netbox_instance/api/virtualization/virtual-disks/1/` ### Database changes N/A ### External dependencies N/A
adam added the status: acceptedtype: featurecomplexity: low labels 2025-12-29 20:47:29 +01:00
adam closed this issue 2025-12-29 20:47:29 +01:00
adam commented 2025-12-29 20:47:29 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 4, 2024):

@ITJamie could you please make another pass over your original request for readability. I think I get the gist, but we need to uphold a minimum standard for grammar and punctuation. (Please rewrite the issue title as well.)

Additionally, "feature branch" is not a valid version. Please indicate a specific NetBox release.

@jeremystretch commented on GitHub (Apr 4, 2024): @ITJamie could you please make another pass over your original request for readability. I think I get the gist, but we need to uphold a minimum standard for grammar and punctuation. (Please rewrite the issue title as well.) Additionally, "feature branch" is not a valid version. Please indicate a specific NetBox release.
adam commented 2025-12-29 20:47:30 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (May 17, 2024):

Hey @ITJamie, I've just made some copy-edits to your title and issue body so that we can get this FR into the product backlog. I wasn't able to puzzle out the meaning of Feature branch as the version, though; would you please change that to a current release which includes the work from #15087?

@jeffgdotorg commented on GitHub (May 17, 2024): Hey @ITJamie, I've just made some copy-edits to your title and issue body so that we can get this FR into the product backlog. I wasn't able to puzzle out the meaning of _Feature branch_ as the version, though; would you please change that to a current release which includes the work from #15087?
adam commented 2025-12-29 20:47:30 +01:00
Author
Owner
Copy Link

@ITJamie commented on GitHub (May 18, 2024):

updated further with an example of possible API response

@ITJamie commented on GitHub (May 18, 2024): updated further with an example of possible API response
adam commented 2025-12-29 20:47:30 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (May 20, 2024):

Thanks for the update @ITJamie. Since this work will involve adding new API response fields, we'll need to schedule it for a minor-version boundary, hence needs milestone status.

@jeffgdotorg commented on GitHub (May 20, 2024): Thanks for the update @ITJamie. Since this work will involve adding new API response fields, we'll need to schedule it for a minor-version boundary, hence `needs milestone` status.
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 complexity: low 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#9250
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?