Ability to add interfaces using name_pattern via the API #2979

New Issue

adam · 2025-12-29T18:24:19+01:00

adam commented

2025-12-29 18:24:19 +01:00

Originally created by @nathbooth on GitHub (Oct 28, 2019).

Environment

Python version: 3.7.4
NetBox version: 2.6.5

Within the core Netbox Functionality it is possible to create interfaces for both devices and device types using a pattern to provide a bulk addition of interfaces matching said pattern. I propose that this functionality is cascaded to the API models for /dcim/interfaces/ and dcim/interface-templates/ allowing the bulk addition of interfaces without providing repetitive API calls to achieve the same result.

Proposed Functionality

Allow pattern as a nested field in the JSON request, if the pattern is defined create the pattern of interfaces.

{
	"device_type": "1234"
	"name": {
		"pattern": "ge-0/0/[0-47]"
	},
	"form_factor": 1000,
	"type": 1000,
	"mgmt_only": false
}

Use Case

Bulk addition of interfaces to devices and device types from the API

Database Changes

None

External Dependencies

None

Originally created by @nathbooth on GitHub (Oct 28, 2019). ### Environment * Python version: 3.7.4 * NetBox version: 2.6.5 Within the core Netbox Functionality it is possible to create interfaces for both devices and device types using a pattern to provide a bulk addition of interfaces matching said pattern. I propose that this functionality is cascaded to the API models for /dcim/interfaces/ and dcim/interface-templates/ allowing the bulk addition of interfaces without providing repetitive API calls to achieve the same result. ### Proposed Functionality Allow pattern as a nested field in the JSON request, if the pattern is defined create the pattern of interfaces. ```json { "device_type": "1234" "name": { "pattern": "ge-0/0/[0-47]" }, "form_factor": 1000, "type": 1000, "mgmt_only": false } ``` ### Use Case Bulk addition of interfaces to devices and device types from the API ### Database Changes None ### External Dependencies None

adam closed this issue

2025-12-29 18:24:19 +01:00

adam commented

2025-12-29 18:24:20 +01:00

@jeremystretch commented on GitHub (Oct 28, 2019):

This would violate one of the fundamental principles of the REST API: One JSON object represents exactly one database object. It would also greatly complicate the serialization and validation logic needed within the API, so I have to reject it.

@jeremystretch commented on GitHub (Oct 28, 2019): This would violate one of the fundamental principles of the REST API: One JSON object represents exactly one database object. It would also _greatly_ complicate the serialization and validation logic needed within the API, so I have to reject it.

adam referenced this issue

2025-12-29 22:21:49 +01:00

[PR #2979] [MERGED] Fixes: #2944 Adding/removing an IP address is not recorded on the associated interface's changelog #12480

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

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#2979