netbox/docs/plugins/development/search.md

Search

Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which holds all search indexes for its models (see the example below).

# search.py
from netbox.search import SearchMixin
from .filters import MyModelFilterSet
from .tables import MyModelTable
from .models import MyModel

class MyModelIndex(SearchMixin):
    model = MyModel
    queryset = MyModel.objects.all()
    filterset = MyModelFilterSet
    table = MyModelTable
    url = 'plugins:myplugin:mymodel_list'

To register one or more indexes with NetBox, define a list named indexes at the end of this file:

indexes = [MyModelIndex]

!!! tip

The path to the list of search indexes can be modified by setting `search_indexes` in the PluginConfig instance.

::: netbox.search.SearchIndex