Inconsistent status field in API for virtual-device-context #8513

New Issue

adam · 2025-12-29T20:37:38+01:00

adam commented

2025-12-29 20:37:38 +01:00

Originally created by @empusas on GitHub (Aug 25, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.5.8

Feature type

Change to existing functionality

Proposed functionality

When using the API or pynetbox module the status for a virtual-device-context is different from the response for a device or virtual-machine.
This lead to parsing errors and requires different parsing of status fields for a vdc.

For example in pynetbox working with a device or virtual-machine
item.status will give back "Active"
item.status.label will give back "Active"
item.status.value will give back "active"

API Response for a device or virtual-machine looks like this:
"status": {
"value": "active",
"label": "Active"
},

For a virtual-device-context there are not value an label fields
item.status will give back "active"

API Response for a device or virtual-device-context looks like this:
"status": "active",

Simple solution is to use str(item.status).lower()

Use case

It would improve the overall consistency of the API to align the status field for a VDC with the status fields for other objects.

Database changes

no

External dependencies

no

Originally created by @empusas on GitHub (Aug 25, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.5.8 ### Feature type Change to existing functionality ### Proposed functionality When using the API or pynetbox module the status for a virtual-device-context is different from the response for a device or virtual-machine. This lead to parsing errors and requires different parsing of status fields for a vdc. For example in pynetbox working with a device or virtual-machine item.status will give back "Active" item.status.label will give back "Active" item.status.value will give back "active" API Response for a device or virtual-machine looks like this: "status": { "value": "active", "label": "Active" }, For a virtual-device-context there are not value an label fields item.status will give back "active" API Response for a device or virtual-device-context looks like this: "status": "active", Simple solution is to use str(item.status).lower() ### Use case It would improve the overall consistency of the API to align the status field for a VDC with the status fields for other objects. ### Database changes no ### External dependencies no

adam added the status: accepted type: feature labels 2025-12-29 20:37:38 +01:00

adam closed this issue

2025-12-29 20:37:38 +01:00

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