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

Doc update for Bulk Object Creation via the API #3757

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

Originally created by @tyler-8 on GitHub (Jun 8, 2020).

Originally assigned to: @tyler-8 on GitHub.

Change Type

[X] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Area

[ ] Installation instructions
[ ] Configuration parameters
[ ] Functionality/features
[X] REST API
[ ] Administration/development
[ ] Other

Proposed Changes

Object bulk-creation was added in NetBox v2.3 as part of https://github.com/netbox-community/netbox/issues/1553, however, beyond that mention in the release notes, the feature doesn't appear to be documented anywhere on the docs page. I propose the snippet from the release notes is also added to the API section of the docs site (perhaps the Examples page). It's a very useful feature that can greatly speed-up API workflows. Happy to take this on myself if accepted.

Originally created by @tyler-8 on GitHub (Jun 8, 2020). Originally assigned to: @tyler-8 on GitHub. <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [X] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) ### Area [ ] Installation instructions [ ] Configuration parameters [ ] Functionality/features [X] REST API [ ] Administration/development [ ] Other <!-- Describe the proposed change(s). --> ### Proposed Changes Object bulk-creation was added in [NetBox v2.3](https://netbox.readthedocs.io/en/stable/release-notes/version-2.3/#bulk-object-creation-via-the-api-155) as part of https://github.com/netbox-community/netbox/issues/1553, however, beyond that mention in the release notes, the feature doesn't appear to be documented anywhere on the docs page. I propose the snippet from the release notes is also added to the API section of the docs site (perhaps the [Examples](https://github.com/netbox-community/netbox/blob/develop/docs/api/examples.md) page). It's a very useful feature that can greatly speed-up API workflows. Happy to take this on myself if accepted.
adam added the status: acceptedtype: documentation labels 2025-12-29 18:31:05 +01:00
adam closed this issue 2025-12-29 18:31:05 +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: documentation
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#3757
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?