Netbox 2.0 API - no support for json_flat #942

New Issue

adam · 2025-12-29T16:27:08+01:00

adam commented

2025-12-29 16:27:08 +01:00

Originally created by @InsaneSplash on GitHub (May 12, 2017).

After upgrading to version 2.0.x with the new API, it no longer supports the type json_flat. We use this format to sync the device and primary IP from Netbox in to Oxidized.

http://netbox/api/dcim/devices/?format=json_flat
{"detail":"Not found."}

Originally created by @InsaneSplash on GitHub (May 12, 2017). After upgrading to version 2.0.x with the new API, it no longer supports the type json_flat. We use this format to sync the device and primary IP from Netbox in to Oxidized. `http://netbox/api/dcim/devices/?format=json_flat` `{"detail":"Not found."}`

adam closed this issue

2025-12-29 16:27:08 +01:00

adam commented

2025-12-29 16:27:08 +01:00

@jeremystretch commented on GitHub (May 12, 2017):

This was a hack added a while back for reasons I don't entirely remember. We've ditched custom renderers entirely in the new API. Instead, you can either modify the API consumer to read regular (nested) JSON, or you can create an export template to generate data in whatever format you prefer. Here's an example:

{% for device in queryset %}{% if device.status == 1 and device.primary_ip %}{{ device.name }}:{{ device.device_type.manufacturer.slug}}
{% endif %}{% endfor %}

This will produce output like this:

abc-switch1:juniper
abc-switch2:juniper
xyz-switch1:cisco
...

@jeremystretch commented on GitHub (May 12, 2017): This was a hack added a while back for reasons I don't entirely remember. We've ditched custom renderers entirely in the new API. Instead, you can either modify the API consumer to read regular (nested) JSON, or you can create an [export template](http://netbox.readthedocs.io/en/stable/data-model/extras/#export-templates) to generate data in whatever format you prefer. Here's an example: ``` {% for device in queryset %}{% if device.status == 1 and device.primary_ip %}{{ device.name }}:{{ device.device_type.manufacturer.slug}} {% endif %}{% endfor %} ``` This will produce output like this: ``` abc-switch1:juniper abc-switch2:juniper xyz-switch1:cisco ... ```

adam commented

2025-12-29 16:27:08 +01:00

@InsaneSplash commented on GitHub (May 12, 2017):

OK. I'll need to bring this up with the Oxidized developer again to see if he will consider adding support for multi-tier json results.

The problem with Oxidized is that its JSON API is not able to read more than 1 level deep. Using the json_flat option allowed me to access the data set since its sometimes located 2 or more levels down. Since one maps the fields it receives from the returned information to a local variable, this functionality is lost.

    map:
      name: name
      ip: primary_ip4_address
      model: platform_slug
      group: tenant_slug

@InsaneSplash commented on GitHub (May 12, 2017): OK. I'll need to bring this up with the Oxidized developer again to see if he will consider adding support for multi-tier json results. The problem with Oxidized is that its JSON API is not able to read more than 1 level deep. Using the json_flat option allowed me to access the data set since its sometimes located 2 or more levels down. Since one maps the fields it receives from the returned information to a local variable, this functionality is lost. ``` map: name: name ip: primary_ip4_address model: platform_slug group: tenant_slug ```

adam commented

2025-12-29 16:27:09 +01:00

@InsaneSplash commented on GitHub (May 12, 2017):

I did end up building a export template, which I used to manually get things up and running though but would prefer a more automated solution. I also don't want the template to necessary be available to all who use the system. I'll have to see what I can do to get around this.

@InsaneSplash commented on GitHub (May 12, 2017): I did end up building a export template, which I used to manually get things up and running though but would prefer a more automated solution. I also don't want the template to necessary be available to all who use the system. I'll have to see what I can do to get around this.

adam commented

2025-12-29 16:27:09 +01:00

@btimmerhuis commented on GitHub (Aug 16, 2017):

@InsaneSplash Could you share the export template? I'm trying the same but can't get the template right. All my attempts result in a JSON::ParserError.

@btimmerhuis commented on GitHub (Aug 16, 2017): @InsaneSplash Could you share the export template? I'm trying the same but can't get the template right. All my attempts result in a JSON::ParserError.

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