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

Export using default CSV options via API #6184

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

Originally created by @joachimtingvold on GitHub (Mar 9, 2022).

NetBox version

v3.1.1

Feature type

Change to existing functionality

Proposed functionality

Be able to use the default exports ("All Data" and "Current View") from the API.

https://netbox.foo.bar/x/y/?export
https://netbox.foo.bar/x/y/?export=table

Both URLs currently exports CSV (either all, or whatever filter/page you have).

https://netbox.foo.bar/api/x/y/?export
https://netbox.foo.bar/api/x/y/?export=table

Both URLs yield {"detail":"Not found."} as response. I'd expect the same CSV to be output via API.

Use case

Be able to export data quickly without having to define custom export templates. Useful for quick offline access or similar.

Database changes

No response

External dependencies

No response

Originally created by @joachimtingvold on GitHub (Mar 9, 2022). ### NetBox version v3.1.1 ### Feature type Change to existing functionality ### Proposed functionality Be able to use the default exports ("All Data" and "Current View") from the API. https://netbox.foo.bar/x/y/?export https://netbox.foo.bar/x/y/?export=table Both URLs currently exports CSV (either all, or whatever filter/page you have). https://netbox.foo.bar/api/x/y/?export https://netbox.foo.bar/api/x/y/?export=table Both URLs yield `{"detail":"Not found."}` as response. I'd expect the same CSV to be output via API. ### Use case Be able to export data quickly without having to define custom export templates. Useful for quick offline access or similar. ### Database changes _No response_ ### External dependencies _No response_
adam added the type: feature label 2025-12-29 19:37:49 +01:00
adam closed this issue 2025-12-29 19:37:49 +01:00
adam commented 2025-12-29 19:37:49 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 9, 2022):

I'm afraid this isn't something we're going to implement. The CSV export is a function of the table object, which is an entirely separate execution path from how API responses are rendered. The expectation of a REST API in general is that an API consumer will request the data it needs and render it in the desired format locally.

@jeremystretch commented on GitHub (Mar 9, 2022): I'm afraid this isn't something we're going to implement. The CSV export is a function of the table object, which is an entirely separate execution path from how API responses are rendered. The expectation of a REST API in general is that an API consumer will request the data it needs and render it in the desired format locally.
adam commented 2025-12-29 19:37:49 +01:00
Author
Owner
Copy Link

@joachimtingvold commented on GitHub (Mar 9, 2022):

Would it not be fairly simple to mimic the CSV output using Jinja-templates, and just have some default ones for each endpoint that can be used when using ?export without specifying any export template? (i.e. a built-in default template, more or less).

edit1; Point being; would be nice to have an easy way to export human readable info, without having to manually create a lot of export templates. Sure, would be fairly easy to create CSV from JSON, but would be nice to have a quick and easy way to do it built-in.

edit2; It could even be done using ?format=csv as well, rather than via the ?export, which would probably make more sense?

@joachimtingvold commented on GitHub (Mar 9, 2022): Would it not be fairly simple to mimic the CSV output using Jinja-templates, and just have some default ones for each endpoint that can be used when using `?export` without specifying any export template? (i.e. a built-in default template, more or less). edit1; Point being; would be nice to have an easy way to export human readable info, without having to manually create a lot of export templates. Sure, would be fairly easy to create CSV from JSON, but would be nice to have a quick and easy way to do it built-in. edit2; It could even be done using `?format=csv` as well, rather than via the `?export`, which would probably make more sense?
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 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#6184
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?