NetBox API

OpenAPI apis-guru enterprise

API to access NetBox

Homepage: https://api.apis.guru/v2/specs/netbox.dev/3.4.json
Provider: netbox.dev
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/netbox.dev/3.4/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/netbox.dev/3.4/openapi.yaml

Tools (846)

Extracted live via the executor SDK.

circuits.circuitsCircuitsBulkDelete
circuits.circuitsCircuitsBulkPartialUpdate
circuits.circuitsCircuitsBulkUpdate
circuits.circuitsCircuitsCreate
circuits.circuitsCircuitsDelete
circuits.circuitsCircuitsList
circuits.circuitsCircuitsPartialUpdate
circuits.circuitsCircuitsRead
circuits.circuitsCircuitsUpdate
circuits.circuitsCircuitTerminationsBulkDelete
circuits.circuitsCircuitTerminationsBulkPartialUpdate
circuits.circuitsCircuitTerminationsBulkUpdate
circuits.circuitsCircuitTerminationsCreate
circuits.circuitsCircuitTerminationsDelete
circuits.circuitsCircuitTerminationsList
circuits.circuitsCircuitTerminationsPartialUpdate
circuits.circuitsCircuitTerminationsPaths

Return all CablePaths which traverse a given pass-through port.
circuits.circuitsCircuitTerminationsRead
circuits.circuitsCircuitTerminationsUpdate
circuits.circuitsCircuitTypesBulkDelete
circuits.circuitsCircuitTypesBulkPartialUpdate
circuits.circuitsCircuitTypesBulkUpdate
circuits.circuitsCircuitTypesCreate
circuits.circuitsCircuitTypesDelete
circuits.circuitsCircuitTypesList
circuits.circuitsCircuitTypesPartialUpdate
circuits.circuitsCircuitTypesRead
circuits.circuitsCircuitTypesUpdate
circuits.circuitsProviderNetworksBulkDelete
circuits.circuitsProviderNetworksBulkPartialUpdate
circuits.circuitsProviderNetworksBulkUpdate
circuits.circuitsProviderNetworksCreate
circuits.circuitsProviderNetworksDelete
circuits.circuitsProviderNetworksList
circuits.circuitsProviderNetworksPartialUpdate
circuits.circuitsProviderNetworksRead
circuits.circuitsProviderNetworksUpdate
circuits.circuitsProvidersBulkDelete
circuits.circuitsProvidersBulkPartialUpdate
circuits.circuitsProvidersBulkUpdate
circuits.circuitsProvidersCreate
circuits.circuitsProvidersDelete
circuits.circuitsProvidersList
circuits.circuitsProvidersPartialUpdate
circuits.circuitsProvidersRead
circuits.circuitsProvidersUpdate
dcim.dcimCablesBulkDelete
dcim.dcimCablesBulkPartialUpdate
dcim.dcimCablesBulkUpdate
dcim.dcimCablesCreate
dcim.dcimCablesDelete
dcim.dcimCablesList
dcim.dcimCablesPartialUpdate
dcim.dcimCablesRead
dcim.dcimCablesUpdate
dcim.dcimCableTerminationsBulkDelete
dcim.dcimCableTerminationsBulkPartialUpdate
dcim.dcimCableTerminationsBulkUpdate
dcim.dcimCableTerminationsCreate
dcim.dcimCableTerminationsDelete
dcim.dcimCableTerminationsList
dcim.dcimCableTerminationsPartialUpdate
dcim.dcimCableTerminationsRead
dcim.dcimCableTerminationsUpdate
dcim.dcimConnectedDeviceList
This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors via a protocol such as LLDP. Two query parameters must be included in the request:
- peer_device: The name of the peer device
- peer_interface: The name of the peer interface
dcim.dcimConsolePortsBulkDelete
dcim.dcimConsolePortsBulkPartialUpdate
dcim.dcimConsolePortsBulkUpdate
dcim.dcimConsolePortsCreate
dcim.dcimConsolePortsDelete
dcim.dcimConsolePortsList
dcim.dcimConsolePortsPartialUpdate
dcim.dcimConsolePortsRead
dcim.dcimConsolePortsTrace

Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim.dcimConsolePortsUpdate
dcim.dcimConsolePortTemplatesBulkDelete
dcim.dcimConsolePortTemplatesBulkPartialUpdate
dcim.dcimConsolePortTemplatesBulkUpdate
dcim.dcimConsolePortTemplatesCreate
dcim.dcimConsolePortTemplatesDelete
dcim.dcimConsolePortTemplatesList
dcim.dcimConsolePortTemplatesPartialUpdate
dcim.dcimConsolePortTemplatesRead
dcim.dcimConsolePortTemplatesUpdate
dcim.dcimConsoleServerPortsBulkDelete
dcim.dcimConsoleServerPortsBulkPartialUpdate
dcim.dcimConsoleServerPortsBulkUpdate
dcim.dcimConsoleServerPortsCreate
dcim.dcimConsoleServerPortsDelete
dcim.dcimConsoleServerPortsList
dcim.dcimConsoleServerPortsPartialUpdate
dcim.dcimConsoleServerPortsRead
dcim.dcimConsoleServerPortsTrace

Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim.dcimConsoleServerPortsUpdate
dcim.dcimConsoleServerPortTemplatesBulkDelete
dcim.dcimConsoleServerPortTemplatesBulkPartialUpdate
dcim.dcimConsoleServerPortTemplatesBulkUpdate
dcim.dcimConsoleServerPortTemplatesCreate
dcim.dcimConsoleServerPortTemplatesDelete
dcim.dcimConsoleServerPortTemplatesList
dcim.dcimConsoleServerPortTemplatesPartialUpdate
dcim.dcimConsoleServerPortTemplatesRead
dcim.dcimConsoleServerPortTemplatesUpdate
dcim.dcimDeviceBaysBulkDelete
dcim.dcimDeviceBaysBulkPartialUpdate
dcim.dcimDeviceBaysBulkUpdate
dcim.dcimDeviceBaysCreate
dcim.dcimDeviceBaysDelete
dcim.dcimDeviceBaysList
dcim.dcimDeviceBaysPartialUpdate
dcim.dcimDeviceBaysRead
dcim.dcimDeviceBaysUpdate
dcim.dcimDeviceBayTemplatesBulkDelete
dcim.dcimDeviceBayTemplatesBulkPartialUpdate
dcim.dcimDeviceBayTemplatesBulkUpdate
dcim.dcimDeviceBayTemplatesCreate
dcim.dcimDeviceBayTemplatesDelete
dcim.dcimDeviceBayTemplatesList
dcim.dcimDeviceBayTemplatesPartialUpdate
dcim.dcimDeviceBayTemplatesRead
dcim.dcimDeviceBayTemplatesUpdate
dcim.dcimDeviceRolesBulkDelete
dcim.dcimDeviceRolesBulkPartialUpdate
dcim.dcimDeviceRolesBulkUpdate
dcim.dcimDeviceRolesCreate
dcim.dcimDeviceRolesDelete
dcim.dcimDeviceRolesList
dcim.dcimDeviceRolesPartialUpdate
dcim.dcimDeviceRolesRead
dcim.dcimDeviceRolesUpdate
dcim.dcimDevicesBulkDelete
dcim.dcimDevicesBulkPartialUpdate
dcim.dcimDevicesBulkUpdate
dcim.dcimDevicesCreate
dcim.dcimDevicesDelete
dcim.dcimDevicesList
dcim.dcimDevicesNapalm

Execute a NAPALM method on a Device
dcim.dcimDevicesPartialUpdate
dcim.dcimDevicesRead
dcim.dcimDevicesUpdate
dcim.dcimDeviceTypesBulkDelete
dcim.dcimDeviceTypesBulkPartialUpdate
dcim.dcimDeviceTypesBulkUpdate
dcim.dcimDeviceTypesCreate
dcim.dcimDeviceTypesDelete
dcim.dcimDeviceTypesList
dcim.dcimDeviceTypesPartialUpdate
dcim.dcimDeviceTypesRead
dcim.dcimDeviceTypesUpdate
dcim.dcimFrontPortsBulkDelete
dcim.dcimFrontPortsBulkPartialUpdate
dcim.dcimFrontPortsBulkUpdate
dcim.dcimFrontPortsCreate
dcim.dcimFrontPortsDelete
dcim.dcimFrontPortsList
dcim.dcimFrontPortsPartialUpdate
dcim.dcimFrontPortsPaths

Return all CablePaths which traverse a given pass-through port.
dcim.dcimFrontPortsRead
dcim.dcimFrontPortsUpdate
dcim.dcimFrontPortTemplatesBulkDelete
dcim.dcimFrontPortTemplatesBulkPartialUpdate
dcim.dcimFrontPortTemplatesBulkUpdate
dcim.dcimFrontPortTemplatesCreate
dcim.dcimFrontPortTemplatesDelete
dcim.dcimFrontPortTemplatesList
dcim.dcimFrontPortTemplatesPartialUpdate
dcim.dcimFrontPortTemplatesRead
dcim.dcimFrontPortTemplatesUpdate
dcim.dcimInterfacesBulkDelete
dcim.dcimInterfacesBulkPartialUpdate
dcim.dcimInterfacesBulkUpdate
dcim.dcimInterfacesCreate
dcim.dcimInterfacesDelete
dcim.dcimInterfacesList
dcim.dcimInterfacesPartialUpdate
dcim.dcimInterfacesRead
dcim.dcimInterfacesTrace

Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim.dcimInterfacesUpdate
dcim.dcimInterfaceTemplatesBulkDelete
dcim.dcimInterfaceTemplatesBulkPartialUpdate
dcim.dcimInterfaceTemplatesBulkUpdate
dcim.dcimInterfaceTemplatesCreate
dcim.dcimInterfaceTemplatesDelete
dcim.dcimInterfaceTemplatesList
dcim.dcimInterfaceTemplatesPartialUpdate
dcim.dcimInterfaceTemplatesRead
dcim.dcimInterfaceTemplatesUpdate
dcim.dcimInventoryItemRolesBulkDelete
dcim.dcimInventoryItemRolesBulkPartialUpdate
dcim.dcimInventoryItemRolesBulkUpdate
dcim.dcimInventoryItemRolesCreate
dcim.dcimInventoryItemRolesDelete
dcim.dcimInventoryItemRolesList
dcim.dcimInventoryItemRolesPartialUpdate
dcim.dcimInventoryItemRolesRead
dcim.dcimInventoryItemRolesUpdate
dcim.dcimInventoryItemsBulkDelete
dcim.dcimInventoryItemsBulkPartialUpdate
dcim.dcimInventoryItemsBulkUpdate
dcim.dcimInventoryItemsCreate
dcim.dcimInventoryItemsDelete
dcim.dcimInventoryItemsList
dcim.dcimInventoryItemsPartialUpdate
dcim.dcimInventoryItemsRead
dcim.dcimInventoryItemsUpdate
dcim.dcimInventoryItemTemplatesBulkDelete
dcim.dcimInventoryItemTemplatesBulkPartialUpdate
dcim.dcimInventoryItemTemplatesBulkUpdate
dcim.dcimInventoryItemTemplatesCreate
dcim.dcimInventoryItemTemplatesDelete
dcim.dcimInventoryItemTemplatesList
dcim.dcimInventoryItemTemplatesPartialUpdate
dcim.dcimInventoryItemTemplatesRead
dcim.dcimInventoryItemTemplatesUpdate
dcim.dcimLocationsBulkDelete
dcim.dcimLocationsBulkPartialUpdate
dcim.dcimLocationsBulkUpdate
dcim.dcimLocationsCreate
dcim.dcimLocationsDelete
dcim.dcimLocationsList
dcim.dcimLocationsPartialUpdate
dcim.dcimLocationsRead
dcim.dcimLocationsUpdate
dcim.dcimManufacturersBulkDelete
dcim.dcimManufacturersBulkPartialUpdate
dcim.dcimManufacturersBulkUpdate
dcim.dcimManufacturersCreate
dcim.dcimManufacturersDelete
dcim.dcimManufacturersList
dcim.dcimManufacturersPartialUpdate
dcim.dcimManufacturersRead
dcim.dcimManufacturersUpdate
dcim.dcimModuleBaysBulkDelete
dcim.dcimModuleBaysBulkPartialUpdate
dcim.dcimModuleBaysBulkUpdate
dcim.dcimModuleBaysCreate
dcim.dcimModuleBaysDelete
dcim.dcimModuleBaysList
dcim.dcimModuleBaysPartialUpdate
dcim.dcimModuleBaysRead
dcim.dcimModuleBaysUpdate
dcim.dcimModuleBayTemplatesBulkDelete
dcim.dcimModuleBayTemplatesBulkPartialUpdate
dcim.dcimModuleBayTemplatesBulkUpdate
dcim.dcimModuleBayTemplatesCreate
dcim.dcimModuleBayTemplatesDelete
dcim.dcimModuleBayTemplatesList
dcim.dcimModuleBayTemplatesPartialUpdate
dcim.dcimModuleBayTemplatesRead
dcim.dcimModuleBayTemplatesUpdate
dcim.dcimModulesBulkDelete
dcim.dcimModulesBulkPartialUpdate
dcim.dcimModulesBulkUpdate
dcim.dcimModulesCreate
dcim.dcimModulesDelete
dcim.dcimModulesList
dcim.dcimModulesPartialUpdate
dcim.dcimModulesRead
dcim.dcimModulesUpdate
dcim.dcimModuleTypesBulkDelete
dcim.dcimModuleTypesBulkPartialUpdate
dcim.dcimModuleTypesBulkUpdate
dcim.dcimModuleTypesCreate
dcim.dcimModuleTypesDelete
dcim.dcimModuleTypesList
dcim.dcimModuleTypesPartialUpdate
dcim.dcimModuleTypesRead
dcim.dcimModuleTypesUpdate
dcim.dcimPlatformsBulkDelete
dcim.dcimPlatformsBulkPartialUpdate
dcim.dcimPlatformsBulkUpdate
dcim.dcimPlatformsCreate
dcim.dcimPlatformsDelete
dcim.dcimPlatformsList
dcim.dcimPlatformsPartialUpdate
dcim.dcimPlatformsRead
dcim.dcimPlatformsUpdate
dcim.dcimPowerFeedsBulkDelete
dcim.dcimPowerFeedsBulkPartialUpdate
dcim.dcimPowerFeedsBulkUpdate
dcim.dcimPowerFeedsCreate
dcim.dcimPowerFeedsDelete
dcim.dcimPowerFeedsList
dcim.dcimPowerFeedsPartialUpdate
dcim.dcimPowerFeedsRead
dcim.dcimPowerFeedsTrace

Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim.dcimPowerFeedsUpdate
dcim.dcimPowerOutletsBulkDelete
dcim.dcimPowerOutletsBulkPartialUpdate
dcim.dcimPowerOutletsBulkUpdate
dcim.dcimPowerOutletsCreate
dcim.dcimPowerOutletsDelete
dcim.dcimPowerOutletsList
dcim.dcimPowerOutletsPartialUpdate
dcim.dcimPowerOutletsRead
dcim.dcimPowerOutletsTrace

Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim.dcimPowerOutletsUpdate
dcim.dcimPowerOutletTemplatesBulkDelete
dcim.dcimPowerOutletTemplatesBulkPartialUpdate
dcim.dcimPowerOutletTemplatesBulkUpdate
dcim.dcimPowerOutletTemplatesCreate
dcim.dcimPowerOutletTemplatesDelete
dcim.dcimPowerOutletTemplatesList
dcim.dcimPowerOutletTemplatesPartialUpdate
dcim.dcimPowerOutletTemplatesRead
dcim.dcimPowerOutletTemplatesUpdate
dcim.dcimPowerPanelsBulkDelete
dcim.dcimPowerPanelsBulkPartialUpdate
dcim.dcimPowerPanelsBulkUpdate
dcim.dcimPowerPanelsCreate
dcim.dcimPowerPanelsDelete
dcim.dcimPowerPanelsList
dcim.dcimPowerPanelsPartialUpdate
dcim.dcimPowerPanelsRead
dcim.dcimPowerPanelsUpdate
dcim.dcimPowerPortsBulkDelete
dcim.dcimPowerPortsBulkPartialUpdate
dcim.dcimPowerPortsBulkUpdate
dcim.dcimPowerPortsCreate
dcim.dcimPowerPortsDelete
dcim.dcimPowerPortsList
dcim.dcimPowerPortsPartialUpdate
dcim.dcimPowerPortsRead
dcim.dcimPowerPortsTrace

Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim.dcimPowerPortsUpdate
dcim.dcimPowerPortTemplatesBulkDelete
dcim.dcimPowerPortTemplatesBulkPartialUpdate
dcim.dcimPowerPortTemplatesBulkUpdate
dcim.dcimPowerPortTemplatesCreate
dcim.dcimPowerPortTemplatesDelete
dcim.dcimPowerPortTemplatesList
dcim.dcimPowerPortTemplatesPartialUpdate
dcim.dcimPowerPortTemplatesRead
dcim.dcimPowerPortTemplatesUpdate
dcim.dcimRackReservationsBulkDelete
dcim.dcimRackReservationsBulkPartialUpdate
dcim.dcimRackReservationsBulkUpdate
dcim.dcimRackReservationsCreate
dcim.dcimRackReservationsDelete
dcim.dcimRackReservationsList
dcim.dcimRackReservationsPartialUpdate
dcim.dcimRackReservationsRead
dcim.dcimRackReservationsUpdate
dcim.dcimRackRolesBulkDelete
dcim.dcimRackRolesBulkPartialUpdate
dcim.dcimRackRolesBulkUpdate
dcim.dcimRackRolesCreate
dcim.dcimRackRolesDelete
dcim.dcimRackRolesList
dcim.dcimRackRolesPartialUpdate
dcim.dcimRackRolesRead
dcim.dcimRackRolesUpdate
dcim.dcimRacksBulkDelete
dcim.dcimRacksBulkPartialUpdate
dcim.dcimRacksBulkUpdate
dcim.dcimRacksCreate
dcim.dcimRacksDelete
dcim.dcimRacksElevation

Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.
dcim.dcimRacksList
dcim.dcimRacksPartialUpdate
dcim.dcimRacksRead
dcim.dcimRacksUpdate
dcim.dcimRearPortsBulkDelete
dcim.dcimRearPortsBulkPartialUpdate
dcim.dcimRearPortsBulkUpdate
dcim.dcimRearPortsCreate
dcim.dcimRearPortsDelete
dcim.dcimRearPortsList
dcim.dcimRearPortsPartialUpdate
dcim.dcimRearPortsPaths

Return all CablePaths which traverse a given pass-through port.
dcim.dcimRearPortsRead
dcim.dcimRearPortsUpdate
dcim.dcimRearPortTemplatesBulkDelete
dcim.dcimRearPortTemplatesBulkPartialUpdate
dcim.dcimRearPortTemplatesBulkUpdate
dcim.dcimRearPortTemplatesCreate
dcim.dcimRearPortTemplatesDelete
dcim.dcimRearPortTemplatesList
dcim.dcimRearPortTemplatesPartialUpdate
dcim.dcimRearPortTemplatesRead
dcim.dcimRearPortTemplatesUpdate
dcim.dcimRegionsBulkDelete
dcim.dcimRegionsBulkPartialUpdate
dcim.dcimRegionsBulkUpdate
dcim.dcimRegionsCreate
dcim.dcimRegionsDelete
dcim.dcimRegionsList
dcim.dcimRegionsPartialUpdate
dcim.dcimRegionsRead
dcim.dcimRegionsUpdate
dcim.dcimSiteGroupsBulkDelete
dcim.dcimSiteGroupsBulkPartialUpdate
dcim.dcimSiteGroupsBulkUpdate
dcim.dcimSiteGroupsCreate
dcim.dcimSiteGroupsDelete
dcim.dcimSiteGroupsList
dcim.dcimSiteGroupsPartialUpdate
dcim.dcimSiteGroupsRead
dcim.dcimSiteGroupsUpdate
dcim.dcimSitesBulkDelete
dcim.dcimSitesBulkPartialUpdate
dcim.dcimSitesBulkUpdate
dcim.dcimSitesCreate
dcim.dcimSitesDelete
dcim.dcimSitesList
dcim.dcimSitesPartialUpdate
dcim.dcimSitesRead
dcim.dcimSitesUpdate
dcim.dcimVirtualChassisBulkDelete
dcim.dcimVirtualChassisBulkPartialUpdate
dcim.dcimVirtualChassisBulkUpdate
dcim.dcimVirtualChassisCreate
dcim.dcimVirtualChassisDelete
dcim.dcimVirtualChassisList
dcim.dcimVirtualChassisPartialUpdate
dcim.dcimVirtualChassisRead
dcim.dcimVirtualChassisUpdate
dcim.dcimVirtualDeviceContextsBulkDelete
dcim.dcimVirtualDeviceContextsBulkPartialUpdate
dcim.dcimVirtualDeviceContextsBulkUpdate
dcim.dcimVirtualDeviceContextsCreate
dcim.dcimVirtualDeviceContextsDelete
dcim.dcimVirtualDeviceContextsList
dcim.dcimVirtualDeviceContextsPartialUpdate
dcim.dcimVirtualDeviceContextsRead
dcim.dcimVirtualDeviceContextsUpdate
extras.extrasConfigContextsBulkDelete
extras.extrasConfigContextsBulkPartialUpdate
extras.extrasConfigContextsBulkUpdate
extras.extrasConfigContextsCreate
extras.extrasConfigContextsDelete
extras.extrasConfigContextsList
extras.extrasConfigContextsPartialUpdate
extras.extrasConfigContextsRead
extras.extrasConfigContextsUpdate
extras.extrasContentTypesList

Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.
extras.extrasContentTypesRead

Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.
extras.extrasCustomFieldsBulkDelete
extras.extrasCustomFieldsBulkPartialUpdate
extras.extrasCustomFieldsBulkUpdate
extras.extrasCustomFieldsCreate
extras.extrasCustomFieldsDelete
extras.extrasCustomFieldsList
extras.extrasCustomFieldsPartialUpdate
extras.extrasCustomFieldsRead
extras.extrasCustomFieldsUpdate
extras.extrasCustomLinksBulkDelete
extras.extrasCustomLinksBulkPartialUpdate
extras.extrasCustomLinksBulkUpdate
extras.extrasCustomLinksCreate
extras.extrasCustomLinksDelete
extras.extrasCustomLinksList
extras.extrasCustomLinksPartialUpdate
extras.extrasCustomLinksRead
extras.extrasCustomLinksUpdate
extras.extrasExportTemplatesBulkDelete
extras.extrasExportTemplatesBulkPartialUpdate
extras.extrasExportTemplatesBulkUpdate
extras.extrasExportTemplatesCreate
extras.extrasExportTemplatesDelete
extras.extrasExportTemplatesList
extras.extrasExportTemplatesPartialUpdate
extras.extrasExportTemplatesRead
extras.extrasExportTemplatesUpdate
extras.extrasImageAttachmentsBulkDelete
extras.extrasImageAttachmentsBulkPartialUpdate
extras.extrasImageAttachmentsBulkUpdate
extras.extrasImageAttachmentsCreate
extras.extrasImageAttachmentsDelete
extras.extrasImageAttachmentsList
extras.extrasImageAttachmentsPartialUpdate
extras.extrasImageAttachmentsRead
extras.extrasImageAttachmentsUpdate
extras.extrasJobResultsList

Retrieve a list of job results
extras.extrasJobResultsRead

Retrieve a list of job results
extras.extrasJournalEntriesBulkDelete
extras.extrasJournalEntriesBulkPartialUpdate
extras.extrasJournalEntriesBulkUpdate
extras.extrasJournalEntriesCreate
extras.extrasJournalEntriesDelete
extras.extrasJournalEntriesList
extras.extrasJournalEntriesPartialUpdate
extras.extrasJournalEntriesRead
extras.extrasJournalEntriesUpdate
extras.extrasObjectChangesList

Retrieve a list of recent changes.
extras.extrasObjectChangesRead

Retrieve a list of recent changes.
extras.extrasReportsList

Compile all reports and their related results (if any). Result data is deferred in the list view.
extras.extrasReportsRead

Retrieve a single Report identified as ".".
extras.extrasReportsRun

Run a Report identified as ".
extras.extrasSavedFiltersBulkDelete
extras.extrasSavedFiltersBulkPartialUpdate
extras.extrasSavedFiltersBulkUpdate
extras.extrasSavedFiltersCreate
extras.extrasSavedFiltersDelete
extras.extrasSavedFiltersList
extras.extrasSavedFiltersPartialUpdate
extras.extrasSavedFiltersRead
extras.extrasSavedFiltersUpdate
extras.extrasScriptsList
extras.extrasScriptsRead
extras.extrasTagsBulkDelete
extras.extrasTagsBulkPartialUpdate
extras.extrasTagsBulkUpdate
extras.extrasTagsCreate
extras.extrasTagsDelete
extras.extrasTagsList
extras.extrasTagsPartialUpdate
extras.extrasTagsRead
extras.extrasTagsUpdate
extras.extrasWebhooksBulkDelete
extras.extrasWebhooksBulkPartialUpdate
extras.extrasWebhooksBulkUpdate
extras.extrasWebhooksCreate
extras.extrasWebhooksDelete
extras.extrasWebhooksList
extras.extrasWebhooksPartialUpdate
extras.extrasWebhooksRead
extras.extrasWebhooksUpdate
ipam.ipamAggregatesBulkDelete
ipam.ipamAggregatesBulkPartialUpdate
ipam.ipamAggregatesBulkUpdate
ipam.ipamAggregatesCreate
ipam.ipamAggregatesDelete
ipam.ipamAggregatesList
ipam.ipamAggregatesPartialUpdate
ipam.ipamAggregatesRead
ipam.ipamAggregatesUpdate
ipam.ipamAsnsBulkDelete
ipam.ipamAsnsBulkPartialUpdate
ipam.ipamAsnsBulkUpdate
ipam.ipamAsnsCreate
ipam.ipamAsnsDelete
ipam.ipamAsnsList
ipam.ipamAsnsPartialUpdate
ipam.ipamAsnsRead
ipam.ipamAsnsUpdate
ipam.ipamFhrpGroupAssignmentsBulkDelete
ipam.ipamFhrpGroupAssignmentsBulkPartialUpdate
ipam.ipamFhrpGroupAssignmentsBulkUpdate
ipam.ipamFhrpGroupAssignmentsCreate
ipam.ipamFhrpGroupAssignmentsDelete
ipam.ipamFhrpGroupAssignmentsList
ipam.ipamFhrpGroupAssignmentsPartialUpdate
ipam.ipamFhrpGroupAssignmentsRead
ipam.ipamFhrpGroupAssignmentsUpdate
ipam.ipamFhrpGroupsBulkDelete
ipam.ipamFhrpGroupsBulkPartialUpdate
ipam.ipamFhrpGroupsBulkUpdate
ipam.ipamFhrpGroupsCreate
ipam.ipamFhrpGroupsDelete
ipam.ipamFhrpGroupsList
ipam.ipamFhrpGroupsPartialUpdate
ipam.ipamFhrpGroupsRead
ipam.ipamFhrpGroupsUpdate
ipam.ipamIpAddressesBulkDelete
ipam.ipamIpAddressesBulkPartialUpdate
ipam.ipamIpAddressesBulkUpdate
ipam.ipamIpAddressesCreate
ipam.ipamIpAddressesDelete
ipam.ipamIpAddressesList
ipam.ipamIpAddressesPartialUpdate
ipam.ipamIpAddressesRead
ipam.ipamIpAddressesUpdate
ipam.ipamIpRangesAvailableIpsCreate
ipam.ipamIpRangesAvailableIpsList
ipam.ipamIpRangesBulkDelete
ipam.ipamIpRangesBulkPartialUpdate
ipam.ipamIpRangesBulkUpdate
ipam.ipamIpRangesCreate
ipam.ipamIpRangesDelete
ipam.ipamIpRangesList
ipam.ipamIpRangesPartialUpdate
ipam.ipamIpRangesRead
ipam.ipamIpRangesUpdate
ipam.ipamL2vpnsBulkDelete
ipam.ipamL2vpnsBulkPartialUpdate
ipam.ipamL2vpnsBulkUpdate
ipam.ipamL2vpnsCreate
ipam.ipamL2vpnsDelete
ipam.ipamL2vpnsList
ipam.ipamL2vpnsPartialUpdate
ipam.ipamL2vpnsRead
ipam.ipamL2vpnsUpdate
ipam.ipamL2vpnTerminationsBulkDelete
ipam.ipamL2vpnTerminationsBulkPartialUpdate
ipam.ipamL2vpnTerminationsBulkUpdate
ipam.ipamL2vpnTerminationsCreate
ipam.ipamL2vpnTerminationsDelete
ipam.ipamL2vpnTerminationsList
ipam.ipamL2vpnTerminationsPartialUpdate
ipam.ipamL2vpnTerminationsRead
ipam.ipamL2vpnTerminationsUpdate
ipam.ipamPrefixesAvailableIpsCreate
ipam.ipamPrefixesAvailableIpsList
ipam.ipamPrefixesAvailablePrefixesCreate
ipam.ipamPrefixesAvailablePrefixesList
ipam.ipamPrefixesBulkDelete
ipam.ipamPrefixesBulkPartialUpdate
ipam.ipamPrefixesBulkUpdate
ipam.ipamPrefixesCreate
ipam.ipamPrefixesDelete
ipam.ipamPrefixesList
ipam.ipamPrefixesPartialUpdate
ipam.ipamPrefixesRead
ipam.ipamPrefixesUpdate
ipam.ipamRirsBulkDelete
ipam.ipamRirsBulkPartialUpdate
ipam.ipamRirsBulkUpdate
ipam.ipamRirsCreate
ipam.ipamRirsDelete
ipam.ipamRirsList
ipam.ipamRirsPartialUpdate
ipam.ipamRirsRead
ipam.ipamRirsUpdate
ipam.ipamRolesBulkDelete
ipam.ipamRolesBulkPartialUpdate
ipam.ipamRolesBulkUpdate
ipam.ipamRolesCreate
ipam.ipamRolesDelete
ipam.ipamRolesList
ipam.ipamRolesPartialUpdate
ipam.ipamRolesRead
ipam.ipamRolesUpdate
ipam.ipamRouteTargetsBulkDelete
ipam.ipamRouteTargetsBulkPartialUpdate
ipam.ipamRouteTargetsBulkUpdate
ipam.ipamRouteTargetsCreate
ipam.ipamRouteTargetsDelete
ipam.ipamRouteTargetsList
ipam.ipamRouteTargetsPartialUpdate
ipam.ipamRouteTargetsRead
ipam.ipamRouteTargetsUpdate
ipam.ipamServicesBulkDelete
ipam.ipamServicesBulkPartialUpdate
ipam.ipamServicesBulkUpdate
ipam.ipamServicesCreate
ipam.ipamServicesDelete
ipam.ipamServicesList
ipam.ipamServicesPartialUpdate
ipam.ipamServicesRead
ipam.ipamServicesUpdate
ipam.ipamServiceTemplatesBulkDelete
ipam.ipamServiceTemplatesBulkPartialUpdate
ipam.ipamServiceTemplatesBulkUpdate
ipam.ipamServiceTemplatesCreate
ipam.ipamServiceTemplatesDelete
ipam.ipamServiceTemplatesList
ipam.ipamServiceTemplatesPartialUpdate
ipam.ipamServiceTemplatesRead
ipam.ipamServiceTemplatesUpdate
ipam.ipamVlanGroupsAvailableVlansCreate
ipam.ipamVlanGroupsAvailableVlansList
ipam.ipamVlanGroupsBulkDelete
ipam.ipamVlanGroupsBulkPartialUpdate
ipam.ipamVlanGroupsBulkUpdate
ipam.ipamVlanGroupsCreate
ipam.ipamVlanGroupsDelete
ipam.ipamVlanGroupsList
ipam.ipamVlanGroupsPartialUpdate
ipam.ipamVlanGroupsRead
ipam.ipamVlanGroupsUpdate
ipam.ipamVlansBulkDelete
ipam.ipamVlansBulkPartialUpdate
ipam.ipamVlansBulkUpdate
ipam.ipamVlansCreate
ipam.ipamVlansDelete
ipam.ipamVlansList
ipam.ipamVlansPartialUpdate
ipam.ipamVlansRead
ipam.ipamVlansUpdate
ipam.ipamVrfsBulkDelete
ipam.ipamVrfsBulkPartialUpdate
ipam.ipamVrfsBulkUpdate
ipam.ipamVrfsCreate
ipam.ipamVrfsDelete
ipam.ipamVrfsList
ipam.ipamVrfsPartialUpdate
ipam.ipamVrfsRead
ipam.ipamVrfsUpdate
status.statusList

A lightweight read-only endpoint for conveying NetBox's current operational status.
tenancy.tenancyContactAssignmentsBulkDelete
tenancy.tenancyContactAssignmentsBulkPartialUpdate
tenancy.tenancyContactAssignmentsBulkUpdate
tenancy.tenancyContactAssignmentsCreate
tenancy.tenancyContactAssignmentsDelete
tenancy.tenancyContactAssignmentsList
tenancy.tenancyContactAssignmentsPartialUpdate
tenancy.tenancyContactAssignmentsRead
tenancy.tenancyContactAssignmentsUpdate
tenancy.tenancyContactGroupsBulkDelete
tenancy.tenancyContactGroupsBulkPartialUpdate
tenancy.tenancyContactGroupsBulkUpdate
tenancy.tenancyContactGroupsCreate
tenancy.tenancyContactGroupsDelete
tenancy.tenancyContactGroupsList
tenancy.tenancyContactGroupsPartialUpdate
tenancy.tenancyContactGroupsRead
tenancy.tenancyContactGroupsUpdate
tenancy.tenancyContactRolesBulkDelete
tenancy.tenancyContactRolesBulkPartialUpdate
tenancy.tenancyContactRolesBulkUpdate
tenancy.tenancyContactRolesCreate
tenancy.tenancyContactRolesDelete
tenancy.tenancyContactRolesList
tenancy.tenancyContactRolesPartialUpdate
tenancy.tenancyContactRolesRead
tenancy.tenancyContactRolesUpdate
tenancy.tenancyContactsBulkDelete
tenancy.tenancyContactsBulkPartialUpdate
tenancy.tenancyContactsBulkUpdate
tenancy.tenancyContactsCreate
tenancy.tenancyContactsDelete
tenancy.tenancyContactsList
tenancy.tenancyContactsPartialUpdate
tenancy.tenancyContactsRead
tenancy.tenancyContactsUpdate
tenancy.tenancyTenantGroupsBulkDelete
tenancy.tenancyTenantGroupsBulkPartialUpdate
tenancy.tenancyTenantGroupsBulkUpdate
tenancy.tenancyTenantGroupsCreate
tenancy.tenancyTenantGroupsDelete
tenancy.tenancyTenantGroupsList
tenancy.tenancyTenantGroupsPartialUpdate
tenancy.tenancyTenantGroupsRead
tenancy.tenancyTenantGroupsUpdate
tenancy.tenancyTenantsBulkDelete
tenancy.tenancyTenantsBulkPartialUpdate
tenancy.tenancyTenantsBulkUpdate
tenancy.tenancyTenantsCreate
tenancy.tenancyTenantsDelete
tenancy.tenancyTenantsList
tenancy.tenancyTenantsPartialUpdate
tenancy.tenancyTenantsRead
tenancy.tenancyTenantsUpdate
users.usersConfigList

Return the UserConfig for the currently authenticated User.
users.usersGroupsBulkDelete
users.usersGroupsBulkPartialUpdate
users.usersGroupsBulkUpdate
users.usersGroupsCreate
users.usersGroupsDelete
users.usersGroupsList
users.usersGroupsPartialUpdate
users.usersGroupsRead
users.usersGroupsUpdate
users.usersPermissionsBulkDelete
users.usersPermissionsBulkPartialUpdate
users.usersPermissionsBulkUpdate
users.usersPermissionsCreate
users.usersPermissionsDelete
users.usersPermissionsList
users.usersPermissionsPartialUpdate
users.usersPermissionsRead
users.usersPermissionsUpdate
users.usersTokensBulkDelete
users.usersTokensBulkPartialUpdate
users.usersTokensBulkUpdate
users.usersTokensCreate
users.usersTokensDelete
users.usersTokensList
users.usersTokensPartialUpdate
users.usersTokensProvisionCreate

Non-authenticated REST API endpoint via which a user may create a Token.
users.usersTokensRead
users.usersTokensUpdate
users.usersUsersBulkDelete
users.usersUsersBulkPartialUpdate
users.usersUsersBulkUpdate
users.usersUsersCreate
users.usersUsersDelete
users.usersUsersList
users.usersUsersPartialUpdate
users.usersUsersRead
users.usersUsersUpdate
virtualization.virtualizationClusterGroupsBulkDelete
virtualization.virtualizationClusterGroupsBulkPartialUpdate
virtualization.virtualizationClusterGroupsBulkUpdate
virtualization.virtualizationClusterGroupsCreate
virtualization.virtualizationClusterGroupsDelete
virtualization.virtualizationClusterGroupsList
virtualization.virtualizationClusterGroupsPartialUpdate
virtualization.virtualizationClusterGroupsRead
virtualization.virtualizationClusterGroupsUpdate
virtualization.virtualizationClustersBulkDelete
virtualization.virtualizationClustersBulkPartialUpdate
virtualization.virtualizationClustersBulkUpdate
virtualization.virtualizationClustersCreate
virtualization.virtualizationClustersDelete
virtualization.virtualizationClustersList
virtualization.virtualizationClustersPartialUpdate
virtualization.virtualizationClustersRead
virtualization.virtualizationClustersUpdate
virtualization.virtualizationClusterTypesBulkDelete
virtualization.virtualizationClusterTypesBulkPartialUpdate
virtualization.virtualizationClusterTypesBulkUpdate
virtualization.virtualizationClusterTypesCreate
virtualization.virtualizationClusterTypesDelete
virtualization.virtualizationClusterTypesList
virtualization.virtualizationClusterTypesPartialUpdate
virtualization.virtualizationClusterTypesRead
virtualization.virtualizationClusterTypesUpdate
virtualization.virtualizationInterfacesBulkDelete
virtualization.virtualizationInterfacesBulkPartialUpdate
virtualization.virtualizationInterfacesBulkUpdate
virtualization.virtualizationInterfacesCreate
virtualization.virtualizationInterfacesDelete
virtualization.virtualizationInterfacesList
virtualization.virtualizationInterfacesPartialUpdate
virtualization.virtualizationInterfacesRead
virtualization.virtualizationInterfacesUpdate
virtualization.virtualizationVirtualMachinesBulkDelete
virtualization.virtualizationVirtualMachinesBulkPartialUpdate
virtualization.virtualizationVirtualMachinesBulkUpdate
virtualization.virtualizationVirtualMachinesCreate
virtualization.virtualizationVirtualMachinesDelete
virtualization.virtualizationVirtualMachinesList
virtualization.virtualizationVirtualMachinesPartialUpdate
virtualization.virtualizationVirtualMachinesRead
virtualization.virtualizationVirtualMachinesUpdate
wireless.wirelessWirelessLanGroupsBulkDelete
wireless.wirelessWirelessLanGroupsBulkPartialUpdate
wireless.wirelessWirelessLanGroupsBulkUpdate
wireless.wirelessWirelessLanGroupsCreate
wireless.wirelessWirelessLanGroupsDelete
wireless.wirelessWirelessLanGroupsList
wireless.wirelessWirelessLanGroupsPartialUpdate
wireless.wirelessWirelessLanGroupsRead
wireless.wirelessWirelessLanGroupsUpdate
wireless.wirelessWirelessLansBulkDelete
wireless.wirelessWirelessLansBulkPartialUpdate
wireless.wirelessWirelessLansBulkUpdate
wireless.wirelessWirelessLansCreate
wireless.wirelessWirelessLansDelete
wireless.wirelessWirelessLansList
wireless.wirelessWirelessLansPartialUpdate
wireless.wirelessWirelessLansRead
wireless.wirelessWirelessLansUpdate
wireless.wirelessWirelessLinksBulkDelete
wireless.wirelessWirelessLinksBulkPartialUpdate
wireless.wirelessWirelessLinksBulkUpdate
wireless.wirelessWirelessLinksCreate
wireless.wirelessWirelessLinksDelete
wireless.wirelessWirelessLinksList
wireless.wirelessWirelessLinksPartialUpdate
wireless.wirelessWirelessLinksRead
wireless.wirelessWirelessLinksUpdate
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools