REST API

Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that instead of rendering arbitrary content using a template, data is returned in JSON format using a serializer.

Generally speaking, there aren't many NetBox-specific components to implementing REST API functionality in a plugin. NetBox employs the Django REST Framework (DRF) for its REST API, and plugin authors will find that they can largely replicate the same patterns found in NetBox's implementation. Some brief examples are included here for reference.

Code Layout

The recommended approach is to separate API serializers, views, and URLs into separate modules under the api/ directory to keep things tidy, particularly for larger projects. The file at api/__init__.py can import the relevant components from each submodule to allow import all API components directly from elsewhere. However, this is merely a convention and not strictly required.

project-name/
  - plugin_name/
    - api/
      - __init__.py
      - serializers.py
      - urls.py
      - views.py
    ...

Serializers

Model Serializers

Serializers are responsible for converting Python objects to JSON data suitable for conveying to consumers, and vice versa. NetBox provides the NetBoxModelSerializer class for use by plugins to handle the assignment of tags and custom field data. (These features can also be included ad hoc via the CustomFieldModelSerializer and TaggableModelSerializer classes.)

Example

To create a serializer for a plugin model, subclass NetBoxModelSerializer in api/serializers.py. Specify the model class and the fields to include within the serializer's Meta class. It is generally advisable to include a url attribute on each serializer. This will render the direct link to access the object being rendered.

# api/serializers.py
from rest_framework import serializers
from netbox.api.serializers import NetBoxModelSerializer
from my_plugin.models import MyModel

class MyModelSerializer(NetBoxModelSerializer):
    url = serializers.HyperlinkedIdentityField(
        view_name='plugins-api:myplugin-api:mymodel-detail'
    )

    class Meta:
        model = MyModel
        fields = ('id', 'foo', 'bar', 'baz')

Nested Serializers

There are two cases where it is generally desirable to show only a minimal representation of an object:

1. When displaying an object related to the one being viewed (for example, the region to which a site is assigned)
2. Listing many objects using "brief" mode

To accommodate these, it is recommended to create nested serializers accompanying the "full" serializer for each model. NetBox provides the WritableNestedSerializer class for just this purpose. This class accepts a primary key value on write, but displays an object representation for read requests. It also includes a read-only display attribute which conveys the string representation of the object.

Example

# api/serializers.py
from rest_framework import serializers
from netbox.api.serializers import WritableNestedSerializer
from my_plugin.models import MyModel

class NestedMyModelSerializer(WritableNestedSerializer):
    url = serializers.HyperlinkedIdentityField(
        view_name='plugins-api:myplugin-api:mymodel-detail'
    )

    class Meta:
        model = MyModel
        fields = ('id', 'display', 'foo')

Viewsets

Just as in the user interface, a REST API view handles the business logic of displaying and interacting with NetBox objects. NetBox provides the NetBoxModelViewSet class, which extends DRF's built-in ModelViewSet to handle bulk operations and object validation.

Unlike the user interface, typically only a single view set is required per model: This view set handles all request types (GET, POST, DELETE, etc.).

Example

To create a viewset for a plugin model, subclass NetBoxModelViewSet in api/views.py, and define the queryset and serializer_class attributes.

# api/views.py
from netbox.api.viewsets import ModelViewSet
from my_plugin.models import MyModel
from .serializers import MyModelSerializer

class MyModelViewSet(ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

Routers

Routers map URLs to REST API views (endpoints). NetBox does not provide any custom components for this; the DefaultRouter class provided by DRF should suffice for most use cases.

Routers should be exposed in api/urls.py. This file must define a variable named urlpatterns.

Example

# api/urls.py
from netbox.api.routers import NetBoxRouter
from .views import MyModelViewSet

router = NetBoxRouter()
router.register('my-model', MyModelViewSet)
urlpatterns = router.urls

This will make the plugin's view accessible at /api/plugins/my-plugin/my-model/.

Warning

The examples provided here are intended to serve as a minimal reference implementation only. This documentation does not address authentication, performance, or myriad other concerns that plugin authors may need to address.