POST api/virtualization/clusters. Can't use name as cluster type. #8753

New Issue

adam · 2025-12-29T20:40:48+01:00

adam commented

2025-12-29 20:40:48 +01:00

Originally created by @JaedanC on GitHub (Oct 18, 2023).

NetBox version

v3.6.5-dev

Python version

3.11

Steps to Reproduce

Create a Cluster Type (any name & slug). eg: "My Type" and "my-type"
Use the API to try to create a Cluster using that Cluster Type:

POST /api/virtualization/clusters/

{
    "name": "My VM",
    "type": "My Type",
    "status": "active"
}

The VM will not be created. If you use that exact JSON inside the Cluster "import" in the NetBox gui, the insert will work. Only the API does not. The API only works if you use the Cluster Type's id.

POST /api/virtualization/clusters/

{
    "name": "My VM",
    "type": 5,
    "status": "active"
}

Expected Behavior

You should be able to use the Cluster Type's name (or slug) in the API just like how the import Cluster feature works. There is an inconsistency here.

Observed Behavior

An error code of 400 is returned which means the API request is invalid.

Originally created by @JaedanC on GitHub (Oct 18, 2023). ### NetBox version v3.6.5-dev ### Python version 3.11 ### Steps to Reproduce 1. Create a Cluster Type (any name & slug). eg: "My Type" and "my-type" 2. Use the API to try to create a Cluster using that Cluster Type: `POST /api/virtualization/clusters/` ```json { "name": "My VM", "type": "My Type", "status": "active" } ``` The VM will not be created. If you use that exact JSON inside the Cluster "import" in the NetBox gui, the insert will work. Only the API does not. The API only works if you use the Cluster Type's `id`. `POST /api/virtualization/clusters/` ```json { "name": "My VM", "type": 5, "status": "active" } ``` ### Expected Behavior You should be able to use the Cluster Type's `name` (or `slug`) in the API just like how the import Cluster feature works. There is an inconsistency here. ### Observed Behavior An error code of 400 is returned which means the API request is invalid.

adam closed this issue

2025-12-29 20:40:48 +01:00

adam commented

2025-12-29 20:40:48 +01:00

@JaedanC commented on GitHub (Oct 18, 2023):

I have also observed not being able to create/update a cluster assigned to a site by using the site's slug. I must use the site's id as well.

@JaedanC commented on GitHub (Oct 18, 2023): I have also observed not being able to create/update a cluster assigned to a site by using the site's slug. I must use the site's id as well.

adam commented

2025-12-29 20:40:49 +01:00

@jeremystretch commented on GitHub (Oct 18, 2023):

This is not a valid format for REST API data. Please consult the documentation for referencing related objects for examples of the supported formats.

@jeremystretch commented on GitHub (Oct 18, 2023): This is not a valid format for REST API data. Please consult the documentation for [referencing related objects](https://docs.netbox.dev/en/stable/integrations/rest-api/#related-objects) for examples of the supported formats.

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