Support for bulk creation of objects via API #1275

New Issue

adam · 2025-12-29T16:30:59+01:00

adam commented

2025-12-29 16:30:59 +01:00

Originally created by @dirtycajunrice on GitHub (Oct 3, 2017).

Issue type

[X] Feature request
[ ] Bug report
[ ] Documentation

Description

Multi-entry API calls would make automation much easier. I have scripted a "New Customer.py" which creates the Tenant, VRF, 10xVLANs, 10xPrefixes, and about 50 initial IPs. Currently, my options are to paste it out to CSV and import it section by section or to create a loop for the HTTP PUSH request which is a nightmare for error checking.

Browsable API example:

[
    {
        "name": "Cust 2",
        "slug": "cust-2",
        "group": 1
    },
    {
        "name": "Cust 3",
        "slug": "cust-3",
        "group": 1
    }
]

Thoughts?

Originally created by @dirtycajunrice on GitHub (Oct 3, 2017). ### Issue type [X] Feature request  [ ] Bug report  [ ] Documentation  ### Description Multi-entry API calls would make automation much easier. I have scripted a "New Customer.py" which creates the Tenant, VRF, 10xVLANs, 10xPrefixes, and about 50 initial IPs. Currently, my options are to paste it out to CSV and import it section by section or to create a loop for the HTTP PUSH request which is a nightmare for error checking. Browsable API example: ``` [ { "name": "Cust 2", "slug": "cust-2", "group": 1 }, { "name": "Cust 3", "slug": "cust-3", "group": 1 } ] ``` Thoughts?

adam added the type: feature label 2025-12-29 16:30:59 +01:00

adam closed this issue

2025-12-29 16:30:59 +01:00

adam commented

2025-12-29 16:31:00 +01:00

@Zimeon- commented on GitHub (Oct 3, 2017):

Ran into the same issue that it didn't accept multiple entries when posting a JSON. Your example is missing [] and a comma between the entries but none the less it doesn't support it. Ended up just making multiple post entries in the script but bulk data in a single json would be nice.

@Zimeon- commented on GitHub (Oct 3, 2017): Ran into the same issue that it didn't accept multiple entries when posting a JSON. Your example is missing [] and a comma between the entries but none the less it doesn't support it. Ended up just making multiple post entries in the script but bulk data in a single json would be nice.

adam commented

2025-12-29 16:31:00 +01:00

@dirtycajunrice commented on GitHub (Oct 3, 2017):

@Zimeon- fixed example. Thanks! Do you have request.error_code and request.response data from each push? And if so how are you logically checking those? Dict?

@dirtycajunrice commented on GitHub (Oct 3, 2017): @Zimeon- fixed example. Thanks! Do you have request.error_code and request.response data from each push? And if so how are you logically checking those? Dict?

adam commented

2025-12-29 16:31:00 +01:00

@Zimeon- commented on GitHub (Oct 4, 2017):

I simply stored the response code and moved along. After that I manually verified the failed ones by hand as I just had to import stuff once from an old db to netbox.

@Zimeon- commented on GitHub (Oct 4, 2017): I simply stored the response code and moved along. After that I manually verified the failed ones by hand as I just had to import stuff once from an old db to netbox.

adam commented

2025-12-29 16:31:00 +01:00

@jeremystretch commented on GitHub (Oct 16, 2017):

This seems simple enough to implement in the writable serializers. We might want to restrict the total number of objects able to be created in one request though: It might be reasonable to reuse the MAX_PAGE_SIZE configuration parameter for that purpose.

@jeremystretch commented on GitHub (Oct 16, 2017): This seems [simple enough to implement](https://stackoverflow.com/questions/14666199/how-do-i-create-multiple-model-instances-with-django-rest-framework#answer-40253309) in the writable serializers. We might want to restrict the total number of objects able to be created in one request though: It might be reasonable to reuse the `MAX_PAGE_SIZE` configuration parameter for that purpose.

adam commented

2025-12-29 16:31:00 +01:00

@dirtycajunrice commented on GitHub (Oct 17, 2017):

Yes i agree that MAX_PAGE_SIZE would safely limit to (500?) by default

@dirtycajunrice commented on GitHub (Oct 17, 2017): Yes i agree that MAX_PAGE_SIZE would safely limit to (500?) by default

Sign in to join this conversation.

Branches Tags

main

21102-fix-graphiql-explorer

update-changelog-comments-docs

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#1275