How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.2.0, 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.2.0
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/
Extras bookmarks list
extras_bookmarks_list 31 params → 200
POST
/api/extras/bookmarks/
Extras bookmarks create
extras_bookmarks_create body → 201
PUT
/api/extras/bookmarks/
Extras bookmarks bulk update
extras_bookmarks_bulk_update body → 200
PATCH
/api/extras/bookmarks/
Extras bookmarks bulk partial update
extras_bookmarks_bulk_partial_update body → 200
DELETE
/api/extras/bookmarks/
Extras bookmarks bulk destroy
extras_bookmarks_bulk_destroy body → 204
GET
/api/extras/bookmarks/{id}/
Extras bookmarks retrieve
extras_bookmarks_retrieve 1 param → 200
PUT
/api/extras/bookmarks/{id}/
Extras bookmarks update
extras_bookmarks_update 1 param body → 200
PATCH
/api/extras/bookmarks/{id}/
Extras bookmarks partial update
extras_bookmarks_partial_update 1 param body → 200
DELETE
/api/extras/bookmarks/{id}/
Extras bookmarks destroy
extras_bookmarks_destroy 1 param → 204
GET
/api/extras/config-context-profiles/
Extras config context profiles list
extras_config_context_profiles_list 78 params → 200
POST
/api/extras/config-context-profiles/
Extras config context profiles create
extras_config_context_profiles_create body → 201
PUT
/api/extras/config-context-profiles/
Extras config context profiles bulk update
extras_config_context_profiles_bulk_update body → 200
PATCH
/api/extras/config-context-profiles/
Extras config context profiles bulk partial update
extras_config_context_profiles_bulk_partial_update body → 200
DELETE
/api/extras/config-context-profiles/
Extras config context profiles bulk destroy
extras_config_context_profiles_bulk_destroy body → 204
GET
/api/extras/config-context-profiles/{id}/
Extras config context profiles retrieve
extras_config_context_profiles_retrieve 1 param → 200
PUT
/api/extras/config-context-profiles/{id}/
Extras config context profiles update
extras_config_context_profiles_update 1 param body → 200
PATCH
/api/extras/config-context-profiles/{id}/
Extras config context profiles partial update
extras_config_context_profiles_partial_update 1 param body → 200
DELETE
/api/extras/config-context-profiles/{id}/
Extras config context profiles destroy
extras_config_context_profiles_destroy 1 param → 204
POST
/api/extras/config-context-profiles/{id}/sync/
Extras config context profiles sync create
extras_config_context_profiles_sync_create 1 param body → 200
GET
/api/extras/config-contexts/
Extras config contexts list
extras_config_contexts_list 134 params → 200
POST
/api/extras/config-contexts/
Extras config contexts create
extras_config_contexts_create body → 201
PUT
/api/extras/config-contexts/
Extras config contexts bulk update
extras_config_contexts_bulk_update body → 200
PATCH
/api/extras/config-contexts/
Extras config contexts bulk partial update
extras_config_contexts_bulk_partial_update body → 200
DELETE
/api/extras/config-contexts/
Extras config contexts bulk destroy
extras_config_contexts_bulk_destroy body → 204
GET
/api/extras/config-contexts/{id}/
Extras config contexts retrieve
extras_config_contexts_retrieve 1 param → 200
PUT
/api/extras/config-contexts/{id}/
Extras config contexts update
extras_config_contexts_update 1 param body → 200
PATCH
/api/extras/config-contexts/{id}/
Extras config contexts partial update
extras_config_contexts_partial_update 1 param body → 200
DELETE
/api/extras/config-contexts/{id}/
Extras config contexts destroy
extras_config_contexts_destroy 1 param → 204
POST
/api/extras/config-contexts/{id}/sync/
Extras config contexts sync create
extras_config_contexts_sync_create 1 param body → 200
GET
/api/extras/config-templates/
Extras config templates list
extras_config_templates_list 118 params → 200
POST
/api/extras/config-templates/
Extras config templates create
extras_config_templates_create body → 201
PUT
/api/extras/config-templates/
Extras config templates bulk update
extras_config_templates_bulk_update body → 200
PATCH
/api/extras/config-templates/
Extras config templates bulk partial update
extras_config_templates_bulk_partial_update body → 200
DELETE
/api/extras/config-templates/
Extras config templates bulk destroy
extras_config_templates_bulk_destroy body → 204
GET
/api/extras/config-templates/{id}/
Extras config templates retrieve
extras_config_templates_retrieve 1 param → 200
PUT
/api/extras/config-templates/{id}/
Extras config templates update
extras_config_templates_update 1 param body → 200
PATCH
/api/extras/config-templates/{id}/
Extras config templates partial update
extras_config_templates_partial_update 1 param body → 200
DELETE
/api/extras/config-templates/{id}/
Extras config templates destroy
extras_config_templates_destroy 1 param → 204
POST
/api/extras/config-templates/{id}/render/
Extras config templates render create
extras_config_templates_render_create 2 params body → 200
POST
/api/extras/config-templates/{id}/sync/
Extras config templates sync create
extras_config_templates_sync_create 1 param body → 200
GET
/api/extras/custom-field-choice-sets/
Extras custom field choice sets list
extras_custom_field_choice_sets_list 77 params → 200
POST
/api/extras/custom-field-choice-sets/
Extras custom field choice sets create
extras_custom_field_choice_sets_create body → 201
PUT
/api/extras/custom-field-choice-sets/
Extras custom field choice sets bulk update
extras_custom_field_choice_sets_bulk_update body → 200
PATCH
/api/extras/custom-field-choice-sets/
Extras custom field choice sets bulk partial update
extras_custom_field_choice_sets_bulk_partial_update body → 200
DELETE
/api/extras/custom-field-choice-sets/
Extras custom field choice sets bulk destroy
extras_custom_field_choice_sets_bulk_destroy body → 204
GET
/api/extras/custom-field-choice-sets/{id}/
Extras custom field choice sets retrieve
extras_custom_field_choice_sets_retrieve 1 param → 200
PUT
/api/extras/custom-field-choice-sets/{id}/
Extras custom field choice sets update
extras_custom_field_choice_sets_update 1 param body → 200
PATCH
/api/extras/custom-field-choice-sets/{id}/
Extras custom field choice sets partial update
extras_custom_field_choice_sets_partial_update 1 param body → 200
DELETE
/api/extras/custom-field-choice-sets/{id}/
Extras custom field choice sets destroy
extras_custom_field_choice_sets_destroy 1 param → 204
GET
/api/extras/custom-field-choice-sets/{id}/choices/
Extras custom field choice sets choices retrieve
extras_custom_field_choice_sets_choices_retrieve 1 param → 200
GET
/api/extras/custom-fields/
Extras custom fields list
extras_custom_fields_list 206 params → 200
POST
/api/extras/custom-fields/
Extras custom fields create
extras_custom_fields_create body → 201
PUT
/api/extras/custom-fields/
Extras custom fields bulk update
extras_custom_fields_bulk_update body → 200
PATCH
/api/extras/custom-fields/
Extras custom fields bulk partial update
extras_custom_fields_bulk_partial_update body → 200
DELETE
/api/extras/custom-fields/
Extras custom fields bulk destroy
extras_custom_fields_bulk_destroy body → 204
GET
/api/extras/custom-fields/{id}/
Extras custom fields retrieve
extras_custom_fields_retrieve 1 param → 200
PUT
/api/extras/custom-fields/{id}/
Extras custom fields update
extras_custom_fields_update 1 param body → 200
PATCH
/api/extras/custom-fields/{id}/
Extras custom fields partial update
extras_custom_fields_partial_update 1 param body → 200
DELETE
/api/extras/custom-fields/{id}/
Extras custom fields destroy
extras_custom_fields_destroy 1 param → 204
GET
/api/extras/custom-links/
Extras custom links list
extras_custom_links_list 122 params → 200
POST
/api/extras/custom-links/
Extras custom links create
extras_custom_links_create body → 201
PUT
/api/extras/custom-links/
Extras custom links bulk update
extras_custom_links_bulk_update body → 200
PATCH
/api/extras/custom-links/
Extras custom links bulk partial update
extras_custom_links_bulk_partial_update body → 200
DELETE
/api/extras/custom-links/
Extras custom links bulk destroy
extras_custom_links_bulk_destroy body → 204
GET
/api/extras/custom-links/{id}/
Extras custom links retrieve
extras_custom_links_retrieve 1 param → 200
PUT
/api/extras/custom-links/{id}/
Extras custom links update
extras_custom_links_update 1 param body → 200
PATCH
/api/extras/custom-links/{id}/
Extras custom links partial update
extras_custom_links_partial_update 1 param body → 200
DELETE
/api/extras/custom-links/{id}/
Extras custom links destroy
extras_custom_links_destroy 1 param → 204
GET
/api/extras/dashboard/
Extras dashboard retrieve
extras_dashboard_retrieve → 200
PUT
/api/extras/dashboard/
Extras dashboard update
extras_dashboard_update body → 200
PATCH
/api/extras/dashboard/
Extras dashboard partial update
extras_dashboard_partial_update body → 200
DELETE
/api/extras/dashboard/
Extras dashboard destroy
extras_dashboard_destroy → 204
GET
/api/extras/event-rules/
Extras event rules list
extras_event_rules_list 104 params → 200
POST
/api/extras/event-rules/
Extras event rules create
extras_event_rules_create body → 201
PUT
/api/extras/event-rules/
Extras event rules bulk update
extras_event_rules_bulk_update body → 200
PATCH
/api/extras/event-rules/
Extras event rules bulk partial update
extras_event_rules_bulk_partial_update body → 200
DELETE
/api/extras/event-rules/
Extras event rules bulk destroy
extras_event_rules_bulk_destroy body → 204
GET
/api/extras/event-rules/{id}/
Extras event rules retrieve
extras_event_rules_retrieve 1 param → 200
PUT
/api/extras/event-rules/{id}/
Extras event rules update
extras_event_rules_update 1 param body → 200
PATCH
/api/extras/event-rules/{id}/
Extras event rules partial update
extras_event_rules_partial_update 1 param body → 200
DELETE
/api/extras/event-rules/{id}/
Extras event rules destroy
extras_event_rules_destroy 1 param → 204
GET
/api/extras/export-templates/
Extras export templates list
extras_export_templates_list 128 params → 200
POST
/api/extras/export-templates/
Extras export templates create
extras_export_templates_create body → 201
PUT
/api/extras/export-templates/
Extras export templates bulk update
extras_export_templates_bulk_update body → 200
PATCH
/api/extras/export-templates/
Extras export templates bulk partial update
extras_export_templates_bulk_partial_update body → 200
DELETE
/api/extras/export-templates/
Extras export templates bulk destroy
extras_export_templates_bulk_destroy body → 204
GET
/api/extras/export-templates/{id}/
Extras export templates retrieve
extras_export_templates_retrieve 1 param → 200
PUT
/api/extras/export-templates/{id}/
Extras export templates update
extras_export_templates_update 1 param body → 200
PATCH
/api/extras/export-templates/{id}/
Extras export templates partial update
extras_export_templates_partial_update 1 param body → 200
DELETE
/api/extras/export-templates/{id}/
Extras export templates destroy
extras_export_templates_destroy 1 param → 204
POST
/api/extras/export-templates/{id}/sync/
Extras export templates sync create
extras_export_templates_sync_create 1 param body → 200
GET
/api/extras/image-attachments/
Extras image attachments list
extras_image_attachments_list 79 params → 200
POST
/api/extras/image-attachments/
Extras image attachments create
extras_image_attachments_create body → 201
PUT
/api/extras/image-attachments/
Extras image attachments bulk update
extras_image_attachments_bulk_update body → 200
PATCH
/api/extras/image-attachments/
Extras image attachments bulk partial update
extras_image_attachments_bulk_partial_update body → 200
DELETE
/api/extras/image-attachments/
Extras image attachments bulk destroy
extras_image_attachments_bulk_destroy body → 204
GET
/api/extras/image-attachments/{id}/
Extras image attachments retrieve
extras_image_attachments_retrieve 1 param → 200
PUT
/api/extras/image-attachments/{id}/
Extras image attachments update
extras_image_attachments_update 1 param body → 200
PATCH
/api/extras/image-attachments/{id}/
Extras image attachments partial update
extras_image_attachments_partial_update 1 param body → 200
DELETE
/api/extras/image-attachments/{id}/
Extras image attachments destroy
extras_image_attachments_destroy 1 param → 204
GET
/api/extras/journal-entries/
Extras journal entries list
extras_journal_entries_list 55 params → 200
POST
/api/extras/journal-entries/
Extras journal entries create
extras_journal_entries_create body → 201
PUT
/api/extras/journal-entries/
Extras journal entries bulk update
extras_journal_entries_bulk_update body → 200
PATCH
/api/extras/journal-entries/
Extras journal entries bulk partial update
extras_journal_entries_bulk_partial_update body → 200
DELETE
/api/extras/journal-entries/
Extras journal entries bulk destroy
extras_journal_entries_bulk_destroy body → 204
GET
/api/extras/journal-entries/{id}/
Extras journal entries retrieve
extras_journal_entries_retrieve 1 param → 200
PUT
/api/extras/journal-entries/{id}/
Extras journal entries update
extras_journal_entries_update 1 param body → 200
PATCH
/api/extras/journal-entries/{id}/
Extras journal entries partial update
extras_journal_entries_partial_update 1 param body → 200
DELETE
/api/extras/journal-entries/{id}/
Extras journal entries destroy
extras_journal_entries_destroy 1 param → 204
GET
/api/extras/notification-groups/
Extras notification groups list
extras_notification_groups_list 3 params → 200
POST
/api/extras/notification-groups/
Extras notification groups create
extras_notification_groups_create body → 201
PUT
/api/extras/notification-groups/
Extras notification groups bulk update
extras_notification_groups_bulk_update body → 200
PATCH
/api/extras/notification-groups/
Extras notification groups bulk partial update
extras_notification_groups_bulk_partial_update body → 200
DELETE
/api/extras/notification-groups/
Extras notification groups bulk destroy
extras_notification_groups_bulk_destroy body → 204
GET
/api/extras/notification-groups/{id}/
Extras notification groups retrieve
extras_notification_groups_retrieve 1 param → 200
PUT
/api/extras/notification-groups/{id}/
Extras notification groups update
extras_notification_groups_update 1 param body → 200
PATCH
/api/extras/notification-groups/{id}/
Extras notification groups partial update
extras_notification_groups_partial_update 1 param body → 200
DELETE
/api/extras/notification-groups/{id}/
Extras notification groups destroy
extras_notification_groups_destroy 1 param → 204
GET
/api/extras/notifications/
Extras notifications list
extras_notifications_list 3 params → 200
POST
/api/extras/notifications/
Extras notifications create
extras_notifications_create body → 201
PUT
/api/extras/notifications/
Extras notifications bulk update
extras_notifications_bulk_update body → 200
PATCH
/api/extras/notifications/
Extras notifications bulk partial update
extras_notifications_bulk_partial_update body → 200
DELETE
/api/extras/notifications/
Extras notifications bulk destroy
extras_notifications_bulk_destroy body → 204
GET
/api/extras/notifications/{id}/
Extras notifications retrieve
extras_notifications_retrieve 1 param → 200
PUT
/api/extras/notifications/{id}/
Extras notifications update
extras_notifications_update 1 param body → 200
PATCH
/api/extras/notifications/{id}/
Extras notifications partial update
extras_notifications_partial_update 1 param body → 200
DELETE
/api/extras/notifications/{id}/
Extras notifications destroy
extras_notifications_destroy 1 param → 204
GET
/api/extras/saved-filters/
Extras saved filters list
extras_saved_filters_list 103 params → 200
POST
/api/extras/saved-filters/
Extras saved filters create
extras_saved_filters_create body → 201
PUT
/api/extras/saved-filters/
Extras saved filters bulk update
extras_saved_filters_bulk_update body → 200
PATCH
/api/extras/saved-filters/
Extras saved filters bulk partial update
extras_saved_filters_bulk_partial_update body → 200
DELETE
/api/extras/saved-filters/
Extras saved filters bulk destroy
extras_saved_filters_bulk_destroy body → 204
GET
/api/extras/saved-filters/{id}/
Extras saved filters retrieve
extras_saved_filters_retrieve 1 param → 200
PUT
/api/extras/saved-filters/{id}/
Extras saved filters update
extras_saved_filters_update 1 param body → 200
PATCH
/api/extras/saved-filters/{id}/
Extras saved filters partial update
extras_saved_filters_partial_update 1 param body → 200
DELETE
/api/extras/saved-filters/{id}/
Extras saved filters destroy
extras_saved_filters_destroy 1 param → 204
GET
/api/extras/scripts/
Extras scripts list
extras_scripts_list 27 params → 200
POST
/api/extras/scripts/
Extras scripts create
extras_scripts_create → 201
GET
/api/extras/scripts/{id}/
Extras scripts retrieve
extras_scripts_retrieve 1 param → 200
PUT
/api/extras/scripts/{id}/
Extras scripts update
extras_scripts_update 1 param body → 200
PATCH
/api/extras/scripts/{id}/
Extras scripts partial update
extras_scripts_partial_update 1 param body → 200
DELETE
/api/extras/scripts/{id}/
Extras scripts destroy
extras_scripts_destroy 1 param → 204
POST
/api/extras/scripts/upload/
Extras scripts upload create
extras_scripts_upload_create body → 201
GET
/api/extras/subscriptions/
Extras subscriptions list
extras_subscriptions_list 3 params → 200
POST
/api/extras/subscriptions/
Extras subscriptions create
extras_subscriptions_create body → 201
PUT
/api/extras/subscriptions/
Extras subscriptions bulk update
extras_subscriptions_bulk_update body → 200
PATCH
/api/extras/subscriptions/
Extras subscriptions bulk partial update
extras_subscriptions_bulk_partial_update body → 200
DELETE
/api/extras/subscriptions/
Extras subscriptions bulk destroy
extras_subscriptions_bulk_destroy body → 204
GET
/api/extras/subscriptions/{id}/
Extras subscriptions retrieve
extras_subscriptions_retrieve 1 param → 200
PUT
/api/extras/subscriptions/{id}/
Extras subscriptions update
extras_subscriptions_update 1 param body → 200
PATCH
/api/extras/subscriptions/{id}/
Extras subscriptions partial update
extras_subscriptions_partial_update 1 param body → 200
DELETE
/api/extras/subscriptions/{id}/
Extras subscriptions destroy
extras_subscriptions_destroy 1 param → 204
GET
/api/extras/table-configs/
Extras table configs list
extras_table_configs_list 85 params → 200
POST
/api/extras/table-configs/
Extras table configs create
extras_table_configs_create body → 201
PUT
/api/extras/table-configs/
Extras table configs bulk update
extras_table_configs_bulk_update body → 200
PATCH
/api/extras/table-configs/
Extras table configs bulk partial update
extras_table_configs_bulk_partial_update body → 200
DELETE
/api/extras/table-configs/
Extras table configs bulk destroy
extras_table_configs_bulk_destroy body → 204
GET
/api/extras/table-configs/{id}/
Extras table configs retrieve
extras_table_configs_retrieve 1 param → 200
PUT
/api/extras/table-configs/{id}/
Extras table configs update
extras_table_configs_update 1 param body → 200
PATCH
/api/extras/table-configs/{id}/
Extras table configs partial update
extras_table_configs_partial_update 1 param body → 200
DELETE
/api/extras/table-configs/{id}/
Extras table configs destroy
extras_table_configs_destroy 1 param → 204
GET
/api/extras/tagged-objects/
Extras tagged objects list
extras_tagged_objects_list 26 params → 200
GET
/api/extras/tagged-objects/{id}/
Extras tagged objects retrieve
extras_tagged_objects_retrieve 1 param → 200
GET
/api/extras/tags/
Extras tags list
extras_tags_list 100 params → 200
POST
/api/extras/tags/
Extras tags create
extras_tags_create body → 201
PUT
/api/extras/tags/
Extras tags bulk update
extras_tags_bulk_update body → 200
PATCH
/api/extras/tags/
Extras tags bulk partial update
extras_tags_bulk_partial_update body → 200
DELETE
/api/extras/tags/
Extras tags bulk destroy
extras_tags_bulk_destroy body → 204
GET
/api/extras/tags/{id}/
Extras tags retrieve
extras_tags_retrieve 1 param → 200
PUT
/api/extras/tags/{id}/
Extras tags update
extras_tags_update 1 param body → 200
PATCH
/api/extras/tags/{id}/
Extras tags partial update
extras_tags_partial_update 1 param body → 200
DELETE
/api/extras/tags/{id}/
Extras tags destroy
extras_tags_destroy 1 param → 204
GET
/api/extras/webhooks/
Extras webhooks list
extras_webhooks_list 120 params → 200
POST
/api/extras/webhooks/
Extras webhooks create
extras_webhooks_create body → 201
PUT
/api/extras/webhooks/
Extras webhooks bulk update
extras_webhooks_bulk_update body → 200
PATCH
/api/extras/webhooks/
Extras webhooks bulk partial update
extras_webhooks_bulk_partial_update body → 200
DELETE
/api/extras/webhooks/
Extras webhooks bulk destroy
extras_webhooks_bulk_destroy body → 204
GET
/api/extras/webhooks/{id}/
Extras webhooks retrieve
extras_webhooks_retrieve 1 param → 200
PUT
/api/extras/webhooks/{id}/
Extras webhooks update
extras_webhooks_update 1 param body → 200
PATCH
/api/extras/webhooks/{id}/
Extras webhooks partial update
extras_webhooks_partial_update 1 param body → 200
DELETE
/api/extras/webhooks/{id}/
Extras webhooks destroy
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), CustomField (30 properties), ConfigContext (30 properties), Site (30 properties). Each schema is shown below with its type and property counts.

PatchedExportTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
BriefSiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 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
EventRuleRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 5 required
PatchedCustomLinkRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
PatchedSavedFilterRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
PaginatedConfigContextList
object
4 properties 2 required
PaginatedNotificationList
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
ExportTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
20 properties 12 required
WebhookRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 2 required
PatchedWritableJournalEntryRequest
object
Adds support for custom fields and tags.
7 properties
PaginatedCustomFieldList
object
4 properties 2 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties 4 required
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
PaginatedNotificationGroupList
object
4 properties 2 required
TenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties 10 required
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
TagRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 2 required
PatchedScriptInputRequest
object
4 properties
CustomLinkRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties 4 required
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 8 required
PaginatedExportTemplateList
object
4 properties 2 required
SavedFilter
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
PaginatedCustomLinkList
object
4 properties 2 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
BriefRegion
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
JournalEntryRequest
object
Adds support for custom fields and tags.
7 properties 3 required
ClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 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
Tag
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 9 required
ScriptInputRequest
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
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
BriefConfigContextProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 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
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 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
BriefTenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
JournalEntry
object
Adds support for custom fields and tags.
14 properties 10 required
PatchedTagRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
CustomFieldChoiceSet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 9 required
PaginatedImageAttachmentList
object
4 properties 2 required
PaginatedJournalEntryList
object
4 properties 2 required
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
Tenant
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 18 required
PaginatedConfigContextProfileList
object
4 properties 2 required
EventRule
object
Adds an owner field for models which have a ForeignKey to users.Owner.
19 properties 12 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
PatchedWebhookRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
PatchedConfigContextRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
21 properties
BriefDataFile
object
Adds support for custom fields and tags.
4 properties 4 required
BriefDataSource
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 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
ClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 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
BriefConfigContextProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PatchedWritableEventRuleRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
PatchedWritableCustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties
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
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
PaginatedCustomFieldChoiceSetList
object
4 properties 2 required
Platform
object
Base serializer class for models inheriting from NestedGroupModel.
19 properties 11 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
PaginatedSubscriptionList
object
4 properties 2 required
WritableJournalEntryRequest
object
Adds support for custom fields and tags.
7 properties 3 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
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
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
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
CustomLink
object
Adds an owner field for models which have a ForeignKey to users.Owner.
16 properties 10 required
DashboardRequest
object
2 properties
BriefManufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
BriefJob
object
5 properties 4 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
WritableCustomFieldRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
23 properties 2 required
ConfigContext
object
Adds an owner field for models which have a ForeignKey to users.Owner.
30 properties 10 required
ConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
21 properties 10 required
ConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 2 required
Location
object
Base serializer class for models inheriting from NestedGroupModel.
22 properties 13 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
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
SiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties 11 required
PaginatedTaggedItemList
object
4 properties 2 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
PatchedConfigContextProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
TaggedItem
object
7 properties 7 required
ConfigContextRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
21 properties 2 required
PatchedWritableCustomFieldRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
23 properties
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
Region
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties 11 required
BriefCustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties 1 required
SavedFilterRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties 4 required
CustomFieldRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
23 properties 3 required
BriefDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PaginatedWebhookList
object
4 properties 2 required
PatchedDashboardRequest
object
2 properties
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
PaginatedConfigTemplateList
object
4 properties 2 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
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
ConfigContextProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 1 required
WritableCustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 2 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
PaginatedBookmarkList
object
4 properties 2 required
PaginatedTableConfigList
object
4 properties 2 required
Cluster
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 14 required
Webhook
object
Adds an owner field for models which have a ForeignKey to users.Owner.
19 properties 8 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
ConfigContextProfile
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 9 required
PaginatedScriptList
object
4 properties 2 required
PaginatedTagList
object
4 properties 2 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
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
BriefClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
WritableEventRuleRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 4 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
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
BriefTag
object
Adds an owner field for models which have a ForeignKey to users.Owner.
7 properties 5 required
CustomFieldChoiceSetRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 2 required
DeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
20 properties 11 required
PaginatedEventRuleList
object
4 properties 2 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
DeviceType
object
Base serializer class for models inheriting from PrimaryModel.
36 properties 20 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
ExportTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties 3 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
PaginatedSavedFilterList
object
4 properties 2 required
CustomField
object
Adds an owner field for models which have a ForeignKey to users.Owner.
30 properties 10 required
Dashboard
object
2 properties
BriefClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 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
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
BriefCustomFieldChoiceSet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
6 properties 5 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
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbox-extras-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbox-extras-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NetBox Extras API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.