starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Documentation for querying custom fields in API missing #1766

New Issue
Closed
opened 2025-12-29 17:18:56 +01:00 by adam · 1 comment
adam commented 2025-12-29 17:18:56 +01:00
Owner
Copy Link

Originally created by @friek on GitHub (Jun 3, 2018).

Issue type

[ ] Feature request
[ ] Bug report
[X] Documentation

Environment

  • Python version: 3.6.2
  • NetBox version: 2.3.4-dev

Description

After hours of searching through documentation and source code how to query custom fields through the API, I eventually found out that this is actually possible by adding a cf_customfieldname=search_value as a query parameter.

This isn't very obvious unfortunately and I can't find anything in the documentation describing this functionality. Therefore, I think it'd be handy to add proper documentation on the API documentation site.

Thanks.

Originally created by @friek on GitHub (Jun 3, 2018). <!-- Before opening a new issue, please search through the existing issues to see if your topic has already been addressed. Note that you may need to remove the "is:open" filter from the search bar to include closed issues. Check the appropriate type for your issue below by placing an x between the brackets. For assistance with installation issues, or for any other issues other than those listed below, please raise your topic for discussion on our mailing list: https://groups.google.com/forum/#!forum/netbox-discuss Please note that issues which do not fall under any of the below categories will be closed. Due to an excessive backlog of feature requests, we are not currently accepting any proposals which extend NetBox's feature scope. Do not prepend any sort of tag to your issue's title. An administrator will review your issue and assign labels as appropriate. ---> ### Issue type [ ] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [X] Documentation <!-- A modification to the documentation --> <!-- Please describe the environment in which you are running NetBox. (Be sure to verify that you are running the latest stable release of NetBox before submitting a bug report.) If you are submitting a bug report and have made any changes to the code base, please first validate that your bug can be recreated while running an official release. --> ### Environment * Python version: 3.6.2 * NetBox version: 2.3.4-dev<!-- Example: 2.1.3 --> <!-- BUG REPORTS must include: * A list of the steps needed for someone else to reproduce the bug * A description of the expected and observed behavior * Any relevant error messages (screenshots may also help) FEATURE REQUESTS must include: * A detailed description of the proposed functionality * A use case for the new feature * A rough description of any necessary changes to the database schema * Any relevant third-party libraries which would be needed --> ### Description After hours of searching through documentation and source code how to query custom fields through the API, I eventually found out that this is actually possible by adding a `cf_customfieldname=search_value` as a query parameter. This isn't very obvious unfortunately and I can't find anything in the documentation describing this functionality. Therefore, I think it'd be handy to add proper documentation on the API documentation site. Thanks.
adam added the status: acceptedtype: documentation labels 2025-12-29 17:18:56 +01:00
adam closed this issue 2025-12-29 17:18:56 +01:00
adam commented 2025-12-29 17:18:57 +01:00
Author
Owner
Copy Link

@a31amit commented on GitHub (Jun 11, 2018):

@friek Thanks for even reporting here, I was struggling with the same thing. It is very useful.

@a31amit commented on GitHub (Jun 11, 2018): @friek Thanks for even reporting here, I was struggling with the same thing. It is very useful.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1766
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?