Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NetBox

NetBox extras API

The extras API from NetBox — 48 operation(s) for extras.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox extras API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include extras. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 181 operations across 48 paths, and defines 138 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).

Requests are made against the base URL https://demo.netbox.dev/api.

181 operations 48 paths 138 schemas 38 DELETE42 GET38 PATCH25 POST38 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.5.9 (4.5)
Base URL
https://demo.netbox.dev/api
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox extras API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token (v1) or Bearer . (v2)

Paths & Operations 181

Across 48 paths, the API surfaces 181 operations — 38 DELETE, 42 GET, 38 PATCH, 25 POST, 38 PUT. Each is listed below with its method, path, parameters, and response codes.

extras 181
GET
/api/extras/bookmarks/
Get a list of bookmark objects.
extras_bookmarks_list 31 params → 200
POST
/api/extras/bookmarks/
Post a list of bookmark objects.
extras_bookmarks_create body → 201
PUT
/api/extras/bookmarks/
Put a list of bookmark objects.
extras_bookmarks_bulk_update body → 200
PATCH
/api/extras/bookmarks/
Patch a list of bookmark objects.
extras_bookmarks_bulk_partial_update body → 200
DELETE
/api/extras/bookmarks/
Delete a list of bookmark objects.
extras_bookmarks_bulk_destroy body → 204
GET
/api/extras/bookmarks/{id}/
Get a bookmark object.
extras_bookmarks_retrieve 1 param → 200
PUT
/api/extras/bookmarks/{id}/
Put a bookmark object.
extras_bookmarks_update 1 param body → 200
PATCH
/api/extras/bookmarks/{id}/
Patch a bookmark object.
extras_bookmarks_partial_update 1 param body → 200
DELETE
/api/extras/bookmarks/{id}/
Delete a bookmark object.
extras_bookmarks_destroy 1 param → 204
GET
/api/extras/config-context-profiles/
Get a list of config context profile objects.
extras_config_context_profiles_list 78 params → 200
POST
/api/extras/config-context-profiles/
Post a list of config context profile objects.
extras_config_context_profiles_create body → 201
PUT
/api/extras/config-context-profiles/
Put a list of config context profile objects.
extras_config_context_profiles_bulk_update body → 200
PATCH
/api/extras/config-context-profiles/
Patch a list of config context profile objects.
extras_config_context_profiles_bulk_partial_update body → 200
DELETE
/api/extras/config-context-profiles/
Delete a list of config context profile objects.
extras_config_context_profiles_bulk_destroy body → 204
GET
/api/extras/config-context-profiles/{id}/
Get a config context profile object.
extras_config_context_profiles_retrieve 1 param → 200
PUT
/api/extras/config-context-profiles/{id}/
Put a config context profile object.
extras_config_context_profiles_update 1 param body → 200
PATCH
/api/extras/config-context-profiles/{id}/
Patch a config context profile object.
extras_config_context_profiles_partial_update 1 param body → 200
DELETE
/api/extras/config-context-profiles/{id}/
Delete a config context profile object.
extras_config_context_profiles_destroy 1 param → 204
POST
/api/extras/config-context-profiles/{id}/sync/
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
extras_config_context_profiles_sync_create 1 param body → 200
GET
/api/extras/config-contexts/
Get a list of config context objects.
extras_config_contexts_list 134 params → 200
POST
/api/extras/config-contexts/
Post a list of config context objects.
extras_config_contexts_create body → 201
PUT
/api/extras/config-contexts/
Put a list of config context objects.
extras_config_contexts_bulk_update body → 200
PATCH
/api/extras/config-contexts/
Patch a list of config context objects.
extras_config_contexts_bulk_partial_update body → 200
DELETE
/api/extras/config-contexts/
Delete a list of config context objects.
extras_config_contexts_bulk_destroy body → 204
GET
/api/extras/config-contexts/{id}/
Get a config context object.
extras_config_contexts_retrieve 1 param → 200
PUT
/api/extras/config-contexts/{id}/
Put a config context object.
extras_config_contexts_update 1 param body → 200
PATCH
/api/extras/config-contexts/{id}/
Patch a config context object.
extras_config_contexts_partial_update 1 param body → 200
DELETE
/api/extras/config-contexts/{id}/
Delete a config context object.
extras_config_contexts_destroy 1 param → 204
POST
/api/extras/config-contexts/{id}/sync/
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
extras_config_contexts_sync_create 1 param body → 200
GET
/api/extras/config-templates/
Get a list of config template objects.
extras_config_templates_list 118 params → 200
POST
/api/extras/config-templates/
Post a list of config template objects.
extras_config_templates_create body → 201
PUT
/api/extras/config-templates/
Put a list of config template objects.
extras_config_templates_bulk_update body → 200
PATCH
/api/extras/config-templates/
Patch a list of config template objects.
extras_config_templates_bulk_partial_update body → 200
DELETE
/api/extras/config-templates/
Delete a list of config template objects.
extras_config_templates_bulk_destroy body → 204
GET
/api/extras/config-templates/{id}/
Get a config template object.
extras_config_templates_retrieve 1 param → 200
PUT
/api/extras/config-templates/{id}/
Put a config template object.
extras_config_templates_update 1 param body → 200
PATCH
/api/extras/config-templates/{id}/
Patch a config template object.
extras_config_templates_partial_update 1 param body → 200
DELETE
/api/extras/config-templates/{id}/
Delete a config template object.
extras_config_templates_destroy 1 param → 204
POST
/api/extras/config-templates/{id}/render/
Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data, return the raw rendered content, rather than serialized JSON.
extras_config_templates_render_create 2 params body → 200
POST
/api/extras/config-templates/{id}/sync/
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
extras_config_templates_sync_create 1 param body → 200
GET
/api/extras/custom-field-choice-sets/
Get a list of custom field choice set objects.
extras_custom_field_choice_sets_list 77 params → 200
POST
/api/extras/custom-field-choice-sets/
Post a list of custom field choice set objects.
extras_custom_field_choice_sets_create body → 201
PUT
/api/extras/custom-field-choice-sets/
Put a list of custom field choice set objects.
extras_custom_field_choice_sets_bulk_update body → 200
PATCH
/api/extras/custom-field-choice-sets/
Patch a list of custom field choice set objects.
extras_custom_field_choice_sets_bulk_partial_update body → 200
DELETE
/api/extras/custom-field-choice-sets/
Delete a list of custom field choice set objects.
extras_custom_field_choice_sets_bulk_destroy body → 204
GET
/api/extras/custom-field-choice-sets/{id}/
Get a custom field choice set object.
extras_custom_field_choice_sets_retrieve 1 param → 200
PUT
/api/extras/custom-field-choice-sets/{id}/
Put a custom field choice set object.
extras_custom_field_choice_sets_update 1 param body → 200
PATCH
/api/extras/custom-field-choice-sets/{id}/
Patch a custom field choice set object.
extras_custom_field_choice_sets_partial_update 1 param body → 200
DELETE
/api/extras/custom-field-choice-sets/{id}/
Delete a custom field choice set object.
extras_custom_field_choice_sets_destroy 1 param → 204
GET
/api/extras/custom-field-choice-sets/{id}/choices/
Provides an endpoint to iterate through each choice in a set.
extras_custom_field_choice_sets_choices_retrieve 1 param → 200
GET
/api/extras/custom-fields/
Get a list of custom field objects.
extras_custom_fields_list 206 params → 200
POST
/api/extras/custom-fields/
Post a list of custom field objects.
extras_custom_fields_create body → 201
PUT
/api/extras/custom-fields/
Put a list of custom field objects.
extras_custom_fields_bulk_update body → 200
PATCH
/api/extras/custom-fields/
Patch a list of custom field objects.
extras_custom_fields_bulk_partial_update body → 200
DELETE
/api/extras/custom-fields/
Delete a list of custom field objects.
extras_custom_fields_bulk_destroy body → 204
GET
/api/extras/custom-fields/{id}/
Get a custom field object.
extras_custom_fields_retrieve 1 param → 200
PUT
/api/extras/custom-fields/{id}/
Put a custom field object.
extras_custom_fields_update 1 param body → 200
PATCH
/api/extras/custom-fields/{id}/
Patch a custom field object.
extras_custom_fields_partial_update 1 param body → 200
DELETE
/api/extras/custom-fields/{id}/
Delete a custom field object.
extras_custom_fields_destroy 1 param → 204
GET
/api/extras/custom-links/
Get a list of custom link objects.
extras_custom_links_list 122 params → 200
POST
/api/extras/custom-links/
Post a list of custom link objects.
extras_custom_links_create body → 201
PUT
/api/extras/custom-links/
Put a list of custom link objects.
extras_custom_links_bulk_update body → 200
PATCH
/api/extras/custom-links/
Patch a list of custom link objects.
extras_custom_links_bulk_partial_update body → 200
DELETE
/api/extras/custom-links/
Delete a list of custom link objects.
extras_custom_links_bulk_destroy body → 204
GET
/api/extras/custom-links/{id}/
Get a custom link object.
extras_custom_links_retrieve 1 param → 200
PUT
/api/extras/custom-links/{id}/
Put a custom link object.
extras_custom_links_update 1 param body → 200
PATCH
/api/extras/custom-links/{id}/
Patch a custom link object.
extras_custom_links_partial_update 1 param body → 200
DELETE
/api/extras/custom-links/{id}/
Delete a custom link object.
extras_custom_links_destroy 1 param → 204
GET
/api/extras/dashboard/
Get a list of dashboard objects.
extras_dashboard_retrieve → 200
PUT
/api/extras/dashboard/
Put a list of dashboard objects.
extras_dashboard_update body → 200
PATCH
/api/extras/dashboard/
Patch a list of dashboard objects.
extras_dashboard_partial_update body → 200
DELETE
/api/extras/dashboard/
Delete a list of dashboard objects.
extras_dashboard_destroy → 204
GET
/api/extras/event-rules/
Get a list of event rule objects.
extras_event_rules_list 104 params → 200
POST
/api/extras/event-rules/
Post a list of event rule objects.
extras_event_rules_create body → 201
PUT
/api/extras/event-rules/
Put a list of event rule objects.
extras_event_rules_bulk_update body → 200
PATCH
/api/extras/event-rules/
Patch a list of event rule objects.
extras_event_rules_bulk_partial_update body → 200
DELETE
/api/extras/event-rules/
Delete a list of event rule objects.
extras_event_rules_bulk_destroy body → 204
GET
/api/extras/event-rules/{id}/
Get a event rule object.
extras_event_rules_retrieve 1 param → 200
PUT
/api/extras/event-rules/{id}/
Put a event rule object.
extras_event_rules_update 1 param body → 200
PATCH
/api/extras/event-rules/{id}/
Patch a event rule object.
extras_event_rules_partial_update 1 param body → 200
DELETE
/api/extras/event-rules/{id}/
Delete a event rule object.
extras_event_rules_destroy 1 param → 204
GET
/api/extras/export-templates/
Get a list of export template objects.
extras_export_templates_list 128 params → 200
POST
/api/extras/export-templates/
Post a list of export template objects.
extras_export_templates_create body → 201
PUT
/api/extras/export-templates/
Put a list of export template objects.
extras_export_templates_bulk_update body → 200
PATCH
/api/extras/export-templates/
Patch a list of export template objects.
extras_export_templates_bulk_partial_update body → 200
DELETE
/api/extras/export-templates/
Delete a list of export template objects.
extras_export_templates_bulk_destroy body → 204
GET
/api/extras/export-templates/{id}/
Get a export template object.
extras_export_templates_retrieve 1 param → 200
PUT
/api/extras/export-templates/{id}/
Put a export template object.
extras_export_templates_update 1 param body → 200
PATCH
/api/extras/export-templates/{id}/
Patch a export template object.
extras_export_templates_partial_update 1 param body → 200
DELETE
/api/extras/export-templates/{id}/
Delete a export template object.
extras_export_templates_destroy 1 param → 204
POST
/api/extras/export-templates/{id}/sync/
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
extras_export_templates_sync_create 1 param body → 200
GET
/api/extras/image-attachments/
Get a list of image attachment objects.
extras_image_attachments_list 79 params → 200
POST
/api/extras/image-attachments/
Post a list of image attachment objects.
extras_image_attachments_create body → 201
PUT
/api/extras/image-attachments/
Put a list of image attachment objects.
extras_image_attachments_bulk_update body → 200
PATCH
/api/extras/image-attachments/
Patch a list of image attachment objects.
extras_image_attachments_bulk_partial_update body → 200
DELETE
/api/extras/image-attachments/
Delete a list of image attachment objects.
extras_image_attachments_bulk_destroy body → 204
GET
/api/extras/image-attachments/{id}/
Get a image attachment object.
extras_image_attachments_retrieve 1 param → 200
PUT
/api/extras/image-attachments/{id}/
Put a image attachment object.
extras_image_attachments_update 1 param body → 200
PATCH
/api/extras/image-attachments/{id}/
Patch a image attachment object.
extras_image_attachments_partial_update 1 param body → 200
DELETE
/api/extras/image-attachments/{id}/
Delete a image attachment object.
extras_image_attachments_destroy 1 param → 204
GET
/api/extras/journal-entries/
Get a list of journal entry objects.
extras_journal_entries_list 55 params → 200
POST
/api/extras/journal-entries/
Post a list of journal entry objects.
extras_journal_entries_create body → 201
PUT
/api/extras/journal-entries/
Put a list of journal entry objects.
extras_journal_entries_bulk_update body → 200
PATCH
/api/extras/journal-entries/
Patch a list of journal entry objects.
extras_journal_entries_bulk_partial_update body → 200
DELETE
/api/extras/journal-entries/
Delete a list of journal entry objects.
extras_journal_entries_bulk_destroy body → 204
GET
/api/extras/journal-entries/{id}/
Get a journal entry object.
extras_journal_entries_retrieve 1 param → 200
PUT
/api/extras/journal-entries/{id}/
Put a journal entry object.
extras_journal_entries_update 1 param body → 200
PATCH
/api/extras/journal-entries/{id}/
Patch a journal entry object.
extras_journal_entries_partial_update 1 param body → 200
DELETE
/api/extras/journal-entries/{id}/
Delete a journal entry object.
extras_journal_entries_destroy 1 param → 204
GET
/api/extras/notification-groups/
Get a list of notification group objects.
extras_notification_groups_list 3 params → 200
POST
/api/extras/notification-groups/
Post a list of notification group objects.
extras_notification_groups_create body → 201
PUT
/api/extras/notification-groups/
Put a list of notification group objects.
extras_notification_groups_bulk_update body → 200
PATCH
/api/extras/notification-groups/
Patch a list of notification group objects.
extras_notification_groups_bulk_partial_update body → 200
DELETE
/api/extras/notification-groups/
Delete a list of notification group objects.
extras_notification_groups_bulk_destroy body → 204
GET
/api/extras/notification-groups/{id}/
Get a notification group object.
extras_notification_groups_retrieve 1 param → 200
PUT
/api/extras/notification-groups/{id}/
Put a notification group object.
extras_notification_groups_update 1 param body → 200
PATCH
/api/extras/notification-groups/{id}/
Patch a notification group object.
extras_notification_groups_partial_update 1 param body → 200
DELETE
/api/extras/notification-groups/{id}/
Delete a notification group object.
extras_notification_groups_destroy 1 param → 204
GET
/api/extras/notifications/
Get a list of notification objects.
extras_notifications_list 3 params → 200
POST
/api/extras/notifications/
Post a list of notification objects.
extras_notifications_create body → 201
PUT
/api/extras/notifications/
Put a list of notification objects.
extras_notifications_bulk_update body → 200
PATCH
/api/extras/notifications/
Patch a list of notification objects.
extras_notifications_bulk_partial_update body → 200
DELETE
/api/extras/notifications/
Delete a list of notification objects.
extras_notifications_bulk_destroy body → 204
GET
/api/extras/notifications/{id}/
Get a notification object.
extras_notifications_retrieve 1 param → 200
PUT
/api/extras/notifications/{id}/
Put a notification object.
extras_notifications_update 1 param body → 200
PATCH
/api/extras/notifications/{id}/
Patch a notification object.
extras_notifications_partial_update 1 param body → 200
DELETE
/api/extras/notifications/{id}/
Delete a notification object.
extras_notifications_destroy 1 param → 204
GET
/api/extras/saved-filters/
Get a list of saved filter objects.
extras_saved_filters_list 103 params → 200
POST
/api/extras/saved-filters/
Post a list of saved filter objects.
extras_saved_filters_create body → 201
PUT
/api/extras/saved-filters/
Put a list of saved filter objects.
extras_saved_filters_bulk_update body → 200
PATCH
/api/extras/saved-filters/
Patch a list of saved filter objects.
extras_saved_filters_bulk_partial_update body → 200
DELETE
/api/extras/saved-filters/
Delete a list of saved filter objects.
extras_saved_filters_bulk_destroy body → 204
GET
/api/extras/saved-filters/{id}/
Get a saved filter object.
extras_saved_filters_retrieve 1 param → 200
PUT
/api/extras/saved-filters/{id}/
Put a saved filter object.
extras_saved_filters_update 1 param body → 200
PATCH
/api/extras/saved-filters/{id}/
Patch a saved filter object.
extras_saved_filters_partial_update 1 param body → 200
DELETE
/api/extras/saved-filters/{id}/
Delete a saved filter object.
extras_saved_filters_destroy 1 param → 204
GET
/api/extras/scripts/
Get a list of script objects.
extras_scripts_list 27 params → 200
POST
/api/extras/scripts/
Post a list of script objects.
extras_scripts_create → 201
GET
/api/extras/scripts/{id}/
Get a script object.
extras_scripts_retrieve 1 param → 200
PUT
/api/extras/scripts/{id}/
Put a script object.
extras_scripts_update 1 param body → 200
PATCH
/api/extras/scripts/{id}/
Patch a script object.
extras_scripts_partial_update 1 param body → 200
DELETE
/api/extras/scripts/{id}/
Delete a script object.
extras_scripts_destroy 1 param → 204
POST
/api/extras/scripts/upload/
Post a list of script module objects.
extras_scripts_upload_create body → 201
GET
/api/extras/subscriptions/
Get a list of subscription objects.
extras_subscriptions_list 3 params → 200
POST
/api/extras/subscriptions/
Post a list of subscription objects.
extras_subscriptions_create body → 201
PUT
/api/extras/subscriptions/
Put a list of subscription objects.
extras_subscriptions_bulk_update body → 200
PATCH
/api/extras/subscriptions/
Patch a list of subscription objects.
extras_subscriptions_bulk_partial_update body → 200
DELETE
/api/extras/subscriptions/
Delete a list of subscription objects.
extras_subscriptions_bulk_destroy body → 204
GET
/api/extras/subscriptions/{id}/
Get a subscription object.
extras_subscriptions_retrieve 1 param → 200
PUT
/api/extras/subscriptions/{id}/
Put a subscription object.
extras_subscriptions_update 1 param body → 200
PATCH
/api/extras/subscriptions/{id}/
Patch a subscription object.
extras_subscriptions_partial_update 1 param body → 200
DELETE
/api/extras/subscriptions/{id}/
Delete a subscription object.
extras_subscriptions_destroy 1 param → 204
GET
/api/extras/table-configs/
Get a list of table config objects.
extras_table_configs_list 85 params → 200
POST
/api/extras/table-configs/
Post a list of table config objects.
extras_table_configs_create body → 201
PUT
/api/extras/table-configs/
Put a list of table config objects.
extras_table_configs_bulk_update body → 200
PATCH
/api/extras/table-configs/
Patch a list of table config objects.
extras_table_configs_bulk_partial_update body → 200
DELETE
/api/extras/table-configs/
Delete a list of table config objects.
extras_table_configs_bulk_destroy body → 204
GET
/api/extras/table-configs/{id}/
Get a table config object.
extras_table_configs_retrieve 1 param → 200
PUT
/api/extras/table-configs/{id}/
Put a table config object.
extras_table_configs_update 1 param body → 200
PATCH
/api/extras/table-configs/{id}/
Patch a table config object.
extras_table_configs_partial_update 1 param body → 200
DELETE
/api/extras/table-configs/{id}/
Delete a table config object.
extras_table_configs_destroy 1 param → 204
GET
/api/extras/tagged-objects/
Get a list of tagged item objects.
extras_tagged_objects_list 26 params → 200
GET
/api/extras/tagged-objects/{id}/
Get a tagged item object.
extras_tagged_objects_retrieve 1 param → 200
GET
/api/extras/tags/
Get a list of tag objects.
extras_tags_list 100 params → 200
POST
/api/extras/tags/
Post a list of tag objects.
extras_tags_create body → 201
PUT
/api/extras/tags/
Put a list of tag objects.
extras_tags_bulk_update body → 200
PATCH
/api/extras/tags/
Patch a list of tag objects.
extras_tags_bulk_partial_update body → 200
DELETE
/api/extras/tags/
Delete a list of tag objects.
extras_tags_bulk_destroy body → 204
GET
/api/extras/tags/{id}/
Get a tag object.
extras_tags_retrieve 1 param → 200
PUT
/api/extras/tags/{id}/
Put a tag object.
extras_tags_update 1 param body → 200
PATCH
/api/extras/tags/{id}/
Patch a tag object.
extras_tags_partial_update 1 param body → 200
DELETE
/api/extras/tags/{id}/
Delete a tag object.
extras_tags_destroy 1 param → 204
GET
/api/extras/webhooks/
Get a list of webhook objects.
extras_webhooks_list 120 params → 200
POST
/api/extras/webhooks/
Post a list of webhook objects.
extras_webhooks_create body → 201
PUT
/api/extras/webhooks/
Put a list of webhook objects.
extras_webhooks_bulk_update body → 200
PATCH
/api/extras/webhooks/
Patch a list of webhook objects.
extras_webhooks_bulk_partial_update body → 200
DELETE
/api/extras/webhooks/
Delete a list of webhook objects.
extras_webhooks_bulk_destroy body → 204
GET
/api/extras/webhooks/{id}/
Get a webhook object.
extras_webhooks_retrieve 1 param → 200
PUT
/api/extras/webhooks/{id}/
Put a webhook object.
extras_webhooks_update 1 param body → 200
PATCH
/api/extras/webhooks/{id}/
Patch a webhook object.
extras_webhooks_partial_update 1 param body → 200
DELETE
/api/extras/webhooks/{id}/
Delete a webhook object.
extras_webhooks_destroy 1 param → 204

Schemas 138

The contract defines 138 schemas that model the data the API accepts and returns. The most detailed are DeviceType (36 properties), ConfigContext (30 properties), Site (30 properties), CustomField (30 properties). Each schema is shown below with its type and property counts.

BookmarkRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
3 properties 3 required
Platform
object
Base serializer class for models inheriting from NestedGroupModel.
19 properties 11 required
ExportTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
20 properties 12 required
ClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required
BriefManufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
ClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required
PatchedNotificationRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties
PaginatedNotificationList
object
4 properties 2 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties 4 required
BriefUserRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
1 property 1 required
PatchedWritableEventRuleRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
CustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 2 required
SavedFilter
object
Adds an owner field for models which have a ForeignKey to users.Owner.
16 properties 10 required
BriefConfigContextProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PatchedTableConfigRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties
Tag
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 9 required
NestedLocation
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
PaginatedImageAttachmentList
object
4 properties 2 required
NotificationGroup
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties 5 required
ImageAttachmentRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 3 required
PatchedWritableCustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties
Notification
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties 9 required
PatchedBookmarkRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
3 properties
JournalEntryRequest
object
Adds support for custom fields and tags.
7 properties 3 required
BriefCustomFieldChoiceSet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 5 required
ConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 2 required
Region
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties 11 required
CustomFieldRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
23 properties 3 required
WritableJournalEntryRequest
object
Adds support for custom fields and tags.
7 properties 3 required
BriefOwner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
User
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
13 properties 5 required
Bookmark
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties 8 required
PatchedWebhookRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
ConfigContext
object
Adds an owner field for models which have a ForeignKey to users.Owner.
30 properties 10 required
PatchedWritableCustomFieldRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
23 properties
SiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties 11 required
WritableCustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 2 required
PaginatedExportTemplateList
object
4 properties 2 required
PaginatedScriptList
object
4 properties 2 required
PaginatedSubscriptionList
object
4 properties 2 required
NestedTenantGroup
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
PatchedDashboardRequest
object
2 properties
Webhook
object
Adds an owner field for models which have a ForeignKey to users.Owner.
19 properties 8 required
PatchedWritableJournalEntryRequest
object
Adds support for custom fields and tags.
7 properties
Dashboard
object
2 properties
CustomFieldChoiceSet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 9 required
WebhookRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 2 required
PaginatedTagList
object
4 properties 2 required
BriefDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
CustomField
object
Adds an owner field for models which have a ForeignKey to users.Owner.
30 properties 10 required
DeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
20 properties 11 required
BriefConfigContextProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
Script
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties 10 required
TaggedItem
object
7 properties 7 required
PaginatedBookmarkList
object
4 properties 2 required
ScriptModule
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 5 required
ObjectPermission
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
12 properties 7 required
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
BriefClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
ConfigContextProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 1 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefTag
object
Adds an owner field for models which have a ForeignKey to users.Owner.
7 properties 5 required
BriefDataSource
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
ConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
21 properties 10 required
Group
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties 6 required
NotificationGroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties 1 required
PatchedCustomLinkRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
PatchedTagRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties
ConfigContextProfile
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 9 required
PatchedNotificationGroupRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties
PaginatedConfigTemplateList
object
4 properties 2 required
PaginatedConfigContextList
object
4 properties 2 required
PaginatedTaggedItemList
object
4 properties 2 required
CustomLinkRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties 4 required
EventRule
object
Adds an owner field for models which have a ForeignKey to users.Owner.
19 properties 12 required
Tenant
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 18 required
Cluster
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 14 required
PaginatedWebhookList
object
4 properties 2 required
NestedGroup
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
ConfigContextRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
21 properties 2 required
BriefRegion
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
BriefClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
BriefJob
object
5 properties 4 required
PaginatedCustomLinkList
object
4 properties 2 required
PatchedConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
NestedSiteGroup
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
PaginatedConfigContextProfileList
object
4 properties 2 required
JournalEntry
object
Adds support for custom fields and tags.
14 properties 10 required
DeviceType
object
Base serializer class for models inheriting from PrimaryModel.
36 properties 20 required
PaginatedJournalEntryList
object
4 properties 2 required
PaginatedCustomFieldChoiceSetList
object
4 properties 2 required
DashboardRequest
object
2 properties
BriefDataFile
object
Adds support for custom fields and tags.
4 properties 4 required
PatchedConfigContextRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
21 properties
BriefSiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
Subscription
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties 8 required
PatchedSavedFilterRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
SubscriptionRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
3 properties 3 required
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PatchedScriptInputRequest
object
4 properties
WritableCustomFieldRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
23 properties 2 required
NestedUser
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
PatchedExportTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
PaginatedNotificationGroupList
object
4 properties 2 required
PatchedSubscriptionRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
3 properties
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 8 required
TableConfig
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
16 properties 10 required
ExportTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties 3 required
ScriptInputRequest
object
4 properties 2 required
ScriptModuleRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
1 property 1 required
CustomLink
object
Adds an owner field for models which have a ForeignKey to users.Owner.
16 properties 10 required
Site
object
Base serializer class for models inheriting from PrimaryModel.
30 properties 14 required
PatchedConfigContextProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
TenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties 10 required
PaginatedSavedFilterList
object
4 properties 2 required
PaginatedCustomFieldList
object
4 properties 2 required
NestedRegion
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
TableConfigRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties 4 required
NestedDeviceRole
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
TagRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 2 required
PaginatedEventRuleList
object
4 properties 2 required
ASNSite
object
This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.
6 properties 5 required
Location
object
Base serializer class for models inheriting from NestedGroupModel.
22 properties 13 required
WritableEventRuleRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 4 required
NestedPlatform
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
EventRuleRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 5 required
BriefCustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties 1 required
BriefUser
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties 4 required
BriefTenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
PaginatedTableConfigList
object
4 properties 2 required
NestedTag
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 6 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
NotificationRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
PatchedImageAttachmentRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
ImageAttachment
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
13 properties 11 required
NestedTagRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties 2 required
SavedFilterRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-extras-api-openapi.yml Raw ↑

Other APIs NetBox publishes across the network.

NetBox GraphQL API
AE Profile APIs.io
NetBox authentication-check API
AE Profile APIs.io
NetBox circuits API
AE Profile APIs.io
NetBox core API
AE Profile APIs.io
NetBox dcim API
AE Profile APIs.io
NetBox ipam API
AE Profile APIs.io
NetBox schema API
AE Profile APIs.io
NetBox status API
AE Profile APIs.io
NetBox tenancy API
AE Profile APIs.io
NetBox users API
AE Profile APIs.io
NetBox virtualization API
AE Profile APIs.io
NetBox vpn API
AE Profile APIs.io
#extras
← Back to N APIs
API Details
ID
netbox:netbox-extras-api
Base URL
https://demo.netbox.dev/api
Docs
https://docs.netbox.dev/en/stable/
Provider
NetBox
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network