Extend the object types REST API endpoint to provide additional details #11292

New Issue

adam · 2025-12-29T21:43:06+01:00

adam commented

2025-12-29 21:43:06 +01:00

Originally created by @jeremystretch on GitHub (Jun 18, 2025).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v4.3.2

Feature type

Change to existing functionality

Proposed functionality

NetBox currently provides a REST API endpoint at /api/extras/object-types/ which lists all registered object types, both within NetBox core as well as from installed plugins. Currently, this provides minimal information about each object type. For instance:

{
    "id": 57,
    "url": "http://netbox:8000/api/extras/object-types/57/",
    "display": "DCIM | site",
    "app_label": "dcim",
    "model": "site"
}

We can improve the functional value of this endpoint in several ways:

Alter the display text to something more human-readable, e.g. "Site" rather than "DCIM | site".
Provide the proper app name as a discrete field in addition to its raw label (e.g. "DCIM" vs. "dcim").
Provide both the singular and plural forms of each model's verbose name.
Include a boolean flag indicating whether the model is provided by a plugin.
Include the REST API endpoint for the model (where applicable).

We should also consider moving the endpoint from extras to core, however that might justify a separate FR.

Use case

This seizes an opportunity to deliver additional valuable context concerning the object types supported by NetBox with minimal overhead, and no changes to the data model itself. This information is useful e.g. for discovery by third party clients.

Database changes

None

External dependencies

None

Originally created by @jeremystretch on GitHub (Jun 18, 2025). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v4.3.2 ### Feature type Change to existing functionality ### Proposed functionality NetBox currently provides a REST API endpoint at `/api/extras/object-types/` which lists all registered object types, both within NetBox core as well as from installed plugins. Currently, this provides minimal information about each object type. For instance: ```json { "id": 57, "url": "http://netbox:8000/api/extras/object-types/57/", "display": "DCIM | site", "app_label": "dcim", "model": "site" } ``` We can improve the functional value of this endpoint in several ways: * Alter the `display` text to something more human-readable, e.g. "Site" rather than "DCIM | site". * Provide the proper app name as a discrete field in addition to its raw label (e.g. "DCIM" vs. "dcim"). * Provide both the singular and plural forms of each model's verbose name. * Include a boolean flag indicating whether the model is provided by a plugin. * Include the REST API endpoint for the model (where applicable). We should also consider moving the endpoint from `extras` to `core`, however that might justify a separate FR. ### Use case This seizes an opportunity to deliver additional valuable context concerning the object types supported by NetBox with minimal overhead, and no changes to the data model itself. This information is useful e.g. for discovery by third party clients. ### Database changes None ### External dependencies None

adam added the status: accepted type: feature complexity: low labels 2025-12-29 21:43:06 +01:00

adam closed this issue

2025-12-29 21:43:06 +01:00

adam referenced this issue

2025-12-29 23:20:41 +01:00

[PR #11292] [MERGED] Fixes #11290 - Use the start time to calculate duration of jobs instead of created time #13766

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