Allow referencing custom field values in custom link templates. #2854

New Issue

adam · 2025-12-29T18:22:49+01:00

adam commented

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

Originally created by @fknorn on GitHub (Sep 5, 2019).

Environment

Python version: 3.6.8
NetBox version: 2.6.2

Proposed Functionality

Allow referencing of custom fields in custom links. Right now, it seems I cannot reference for instance obj.custom_fields.prtg_id in a custom link template.

Use Case

I have an external monitoring tool where devices have their own unique ID. I added a custom field for storing this ID, and I now would like to create deeplink to the device in the monitoring tool using that custom field.

Database Changes

Unsure, but I believe none, since the custom field functionality is already implemented.

External Dependencies

None.

Current result if attempting this

I am using this as Text in the custom link:

https://monitoring.example.com/device.htm?id={{ obj.custom_fields.prtg_id }}&tabid=1

but upon redering the device page, I get an exception

<class 'jinja2.exceptions.UndefinedError'>

'dcim.models.Device object' has no attribute 'custom_fields'

However, looking at the corresponding page with the API viewer that field is there:

HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 2,
[ -- snip -- ]
    "comments": "",
    "local_context_data": null,
    "tags": [],
    "custom_fields": {
        "prtg_id": 13951
    },
    "config_context": {},
[ -- snip -- ]
}

Originally created by @fknorn on GitHub (Sep 5, 2019).  ### Environment * Python version: 3.6.8 * NetBox version: 2.6.2 ### Proposed Functionality Allow referencing of custom fields in custom links. Right now, it seems I cannot reference for instance `obj.custom_fields.prtg_id` in a custom link template. ### Use Case I have an external monitoring tool where devices have their own unique ID. I added a custom field for storing this ID, and I now would like to create deeplink to the device in the monitoring tool using that custom field. ### Database Changes Unsure, but I believe none, since the custom field functionality is already implemented. ### External Dependencies None. ### Current result if attempting this I am using this as Text in the custom link: `https://monitoring.example.com/device.htm?id={{ obj.custom_fields.prtg_id }}&tabid=1` but upon redering the device page, I get an exception ``` <class 'jinja2.exceptions.UndefinedError'> 'dcim.models.Device object' has no attribute 'custom_fields' ``` However, looking at the corresponding page with the API viewer that field is there: ``` HTTP 200 OK Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS Content-Type: application/json Vary: Accept { "id": 2, [ -- snip -- ] "comments": "", "local_context_data": null, "tags": [], "custom_fields": { "prtg_id": 13951 }, "config_context": {}, [ -- snip -- ] } ```

adam closed this issue

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

adam commented

2025-12-29 18:22:50 +01:00

@rmrf-run commented on GitHub (Sep 5, 2019):

have you tried https://monitoring.example.com/device.htm?id={{obj.cf['prtg_id']}}&tabid=1? that is how my custom links are working with my monitoring tool

@rmrf-run commented on GitHub (Sep 5, 2019): have you tried `https://monitoring.example.com/device.htm?id={{obj.cf['prtg_id']}}&tabid=1`? that is how my custom links are working with my monitoring tool

adam commented

2025-12-29 18:22:50 +01:00

@jeremystretch commented on GitHub (Sep 5, 2019):

As @rmrf-run points out, custom fields are accessible under the cf property.

@jeremystretch commented on GitHub (Sep 5, 2019): As @rmrf-run points out, custom fields are accessible under the `cf` property.

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