NetBox API

OpenAPI apis-guru cloud

API to access NetBox

Homepage: https://api.apis.guru/v2/specs/netboxdemo.com/2.4.json
Provider: netboxdemo.com
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/netboxdemo.com/2.4/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/netboxdemo.com/2.4/openapi.yaml

Tools (359)

Extracted live via the executor SDK.

circuits.circuitsChoicesList
circuits.circuitsChoicesRead
circuits.circuitsCircuitsCreate
circuits.circuitsCircuitsDelete
circuits.circuitsCircuitsList
circuits.circuitsCircuitsPartialUpdate
circuits.circuitsCircuitsRead
circuits.circuitsCircuitsUpdate
circuits.circuitsCircuitTerminationsCreate
circuits.circuitsCircuitTerminationsDelete
circuits.circuitsCircuitTerminationsList
circuits.circuitsCircuitTerminationsPartialUpdate
circuits.circuitsCircuitTerminationsRead
circuits.circuitsCircuitTerminationsUpdate
circuits.circuitsCircuitTypesCreate
circuits.circuitsCircuitTypesDelete
circuits.circuitsCircuitTypesList
circuits.circuitsCircuitTypesPartialUpdate
circuits.circuitsCircuitTypesRead
circuits.circuitsCircuitTypesUpdate
circuits.circuitsProvidersCreate
circuits.circuitsProvidersDelete
circuits.circuitsProvidersGraphs

A convenience method for rendering graphs for a particular provider.
circuits.circuitsProvidersList
circuits.circuitsProvidersPartialUpdate
circuits.circuitsProvidersRead
circuits.circuitsProvidersUpdate
dcim.dcimChoicesList
dcim.dcimChoicesRead
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.dcimConsoleConnectionsList
dcim.dcimConsolePortsCreate
dcim.dcimConsolePortsDelete
dcim.dcimConsolePortsList
dcim.dcimConsolePortsPartialUpdate
dcim.dcimConsolePortsRead
dcim.dcimConsolePortsUpdate
dcim.dcimConsolePortTemplatesCreate
dcim.dcimConsolePortTemplatesDelete
dcim.dcimConsolePortTemplatesList
dcim.dcimConsolePortTemplatesPartialUpdate
dcim.dcimConsolePortTemplatesRead
dcim.dcimConsolePortTemplatesUpdate
dcim.dcimConsoleServerPortsCreate
dcim.dcimConsoleServerPortsDelete
dcim.dcimConsoleServerPortsList
dcim.dcimConsoleServerPortsPartialUpdate
dcim.dcimConsoleServerPortsRead
dcim.dcimConsoleServerPortsUpdate
dcim.dcimConsoleServerPortTemplatesCreate
dcim.dcimConsoleServerPortTemplatesDelete
dcim.dcimConsoleServerPortTemplatesList
dcim.dcimConsoleServerPortTemplatesPartialUpdate
dcim.dcimConsoleServerPortTemplatesRead
dcim.dcimConsoleServerPortTemplatesUpdate
dcim.dcimDeviceBaysCreate
dcim.dcimDeviceBaysDelete
dcim.dcimDeviceBaysList
dcim.dcimDeviceBaysPartialUpdate
dcim.dcimDeviceBaysRead
dcim.dcimDeviceBaysUpdate
dcim.dcimDeviceBayTemplatesCreate
dcim.dcimDeviceBayTemplatesDelete
dcim.dcimDeviceBayTemplatesList
dcim.dcimDeviceBayTemplatesPartialUpdate
dcim.dcimDeviceBayTemplatesRead
dcim.dcimDeviceBayTemplatesUpdate
dcim.dcimDeviceRolesCreate
dcim.dcimDeviceRolesDelete
dcim.dcimDeviceRolesList
dcim.dcimDeviceRolesPartialUpdate
dcim.dcimDeviceRolesRead
dcim.dcimDeviceRolesUpdate
dcim.dcimDevicesCreate
dcim.dcimDevicesDelete
dcim.dcimDevicesList
dcim.dcimDevicesNapalm

Execute a NAPALM method on a Device
dcim.dcimDevicesPartialUpdate
dcim.dcimDevicesRead
dcim.dcimDevicesUpdate
dcim.dcimDeviceTypesCreate
dcim.dcimDeviceTypesDelete
dcim.dcimDeviceTypesList
dcim.dcimDeviceTypesPartialUpdate
dcim.dcimDeviceTypesRead
dcim.dcimDeviceTypesUpdate
dcim.dcimInterfaceConnectionsCreate
dcim.dcimInterfaceConnectionsDelete
dcim.dcimInterfaceConnectionsList
dcim.dcimInterfaceConnectionsPartialUpdate
dcim.dcimInterfaceConnectionsRead
dcim.dcimInterfaceConnectionsUpdate
dcim.dcimInterfacesCreate
dcim.dcimInterfacesDelete
dcim.dcimInterfacesGraphs

A convenience method for rendering graphs for a particular interface.
dcim.dcimInterfacesList
dcim.dcimInterfacesPartialUpdate
dcim.dcimInterfacesRead
dcim.dcimInterfacesUpdate
dcim.dcimInterfaceTemplatesCreate
dcim.dcimInterfaceTemplatesDelete
dcim.dcimInterfaceTemplatesList
dcim.dcimInterfaceTemplatesPartialUpdate
dcim.dcimInterfaceTemplatesRead
dcim.dcimInterfaceTemplatesUpdate
dcim.dcimInventoryItemsCreate
dcim.dcimInventoryItemsDelete
dcim.dcimInventoryItemsList
dcim.dcimInventoryItemsPartialUpdate
dcim.dcimInventoryItemsRead
dcim.dcimInventoryItemsUpdate
dcim.dcimManufacturersCreate
dcim.dcimManufacturersDelete
dcim.dcimManufacturersList
dcim.dcimManufacturersPartialUpdate
dcim.dcimManufacturersRead
dcim.dcimManufacturersUpdate
dcim.dcimPlatformsCreate
dcim.dcimPlatformsDelete
dcim.dcimPlatformsList
dcim.dcimPlatformsPartialUpdate
dcim.dcimPlatformsRead
dcim.dcimPlatformsUpdate
dcim.dcimPowerConnectionsList
dcim.dcimPowerOutletsCreate
dcim.dcimPowerOutletsDelete
dcim.dcimPowerOutletsList
dcim.dcimPowerOutletsPartialUpdate
dcim.dcimPowerOutletsRead
dcim.dcimPowerOutletsUpdate
dcim.dcimPowerOutletTemplatesCreate
dcim.dcimPowerOutletTemplatesDelete
dcim.dcimPowerOutletTemplatesList
dcim.dcimPowerOutletTemplatesPartialUpdate
dcim.dcimPowerOutletTemplatesRead
dcim.dcimPowerOutletTemplatesUpdate
dcim.dcimPowerPortsCreate
dcim.dcimPowerPortsDelete
dcim.dcimPowerPortsList
dcim.dcimPowerPortsPartialUpdate
dcim.dcimPowerPortsRead
dcim.dcimPowerPortsUpdate
dcim.dcimPowerPortTemplatesCreate
dcim.dcimPowerPortTemplatesDelete
dcim.dcimPowerPortTemplatesList
dcim.dcimPowerPortTemplatesPartialUpdate
dcim.dcimPowerPortTemplatesRead
dcim.dcimPowerPortTemplatesUpdate
dcim.dcimRackGroupsCreate
dcim.dcimRackGroupsDelete
dcim.dcimRackGroupsList
dcim.dcimRackGroupsPartialUpdate
dcim.dcimRackGroupsRead
dcim.dcimRackGroupsUpdate
dcim.dcimRackReservationsCreate
dcim.dcimRackReservationsDelete
dcim.dcimRackReservationsList
dcim.dcimRackReservationsPartialUpdate
dcim.dcimRackReservationsRead
dcim.dcimRackReservationsUpdate
dcim.dcimRackRolesCreate
dcim.dcimRackRolesDelete
dcim.dcimRackRolesList
dcim.dcimRackRolesPartialUpdate
dcim.dcimRackRolesRead
dcim.dcimRackRolesUpdate
dcim.dcimRacksCreate
dcim.dcimRacksDelete
dcim.dcimRacksList
dcim.dcimRacksPartialUpdate
dcim.dcimRacksRead
dcim.dcimRacksUnits

List rack units (by rack)
dcim.dcimRacksUpdate
dcim.dcimRegionsCreate
dcim.dcimRegionsDelete
dcim.dcimRegionsList
dcim.dcimRegionsPartialUpdate
dcim.dcimRegionsRead
dcim.dcimRegionsUpdate
dcim.dcimSitesCreate
dcim.dcimSitesDelete
dcim.dcimSitesGraphs

A convenience method for rendering graphs for a particular site.
dcim.dcimSitesList
dcim.dcimSitesPartialUpdate
dcim.dcimSitesRead
dcim.dcimSitesUpdate
dcim.dcimVirtualChassisCreate
dcim.dcimVirtualChassisDelete
dcim.dcimVirtualChassisList
dcim.dcimVirtualChassisPartialUpdate
dcim.dcimVirtualChassisRead
dcim.dcimVirtualChassisUpdate
extras.extrasChoicesList
extras.extrasChoicesRead
extras.extrasConfigContextsCreate
extras.extrasConfigContextsDelete
extras.extrasConfigContextsList
extras.extrasConfigContextsPartialUpdate
extras.extrasConfigContextsRead
extras.extrasConfigContextsUpdate
extras.extrasExportTemplatesCreate
extras.extrasExportTemplatesDelete
extras.extrasExportTemplatesList
extras.extrasExportTemplatesPartialUpdate
extras.extrasExportTemplatesRead
extras.extrasExportTemplatesUpdate
extras.extrasGraphsCreate
extras.extrasGraphsDelete
extras.extrasGraphsList
extras.extrasGraphsPartialUpdate
extras.extrasGraphsRead
extras.extrasGraphsUpdate
extras.extrasImageAttachmentsCreate
extras.extrasImageAttachmentsDelete
extras.extrasImageAttachmentsList
extras.extrasImageAttachmentsPartialUpdate
extras.extrasImageAttachmentsRead
extras.extrasImageAttachmentsUpdate
extras.extrasObjectChangesList

Retrieve a list of recent changes.
extras.extrasObjectChangesRead

Retrieve a list of recent changes.
extras.extrasRecentActivityList
extras.extrasRecentActivityRead
extras.extrasTagsCreate
extras.extrasTagsDelete
extras.extrasTagsList
extras.extrasTagsPartialUpdate
extras.extrasTagsRead
extras.extrasTagsUpdate
extras.extrasTopologyMapsCreate
extras.extrasTopologyMapsDelete
extras.extrasTopologyMapsList
extras.extrasTopologyMapsPartialUpdate
extras.extrasTopologyMapsRead
extras.extrasTopologyMapsRender
extras.extrasTopologyMapsUpdate
ipam.ipamAggregatesCreate
ipam.ipamAggregatesDelete
ipam.ipamAggregatesList
ipam.ipamAggregatesPartialUpdate
ipam.ipamAggregatesRead
ipam.ipamAggregatesUpdate
ipam.ipamChoicesList
ipam.ipamChoicesRead
ipam.ipamIpAddressesCreate
ipam.ipamIpAddressesDelete
ipam.ipamIpAddressesList
ipam.ipamIpAddressesPartialUpdate
ipam.ipamIpAddressesRead
ipam.ipamIpAddressesUpdate
ipam.ipamPrefixesAvailableIpsCreate

A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.
ipam.ipamPrefixesAvailableIpsRead

A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.
ipam.ipamPrefixesAvailablePrefixesCreate

A convenience method for returning available child prefixes within a parent.
ipam.ipamPrefixesAvailablePrefixesRead

A convenience method for returning available child prefixes within a parent.
ipam.ipamPrefixesCreate
ipam.ipamPrefixesDelete
ipam.ipamPrefixesList
ipam.ipamPrefixesPartialUpdate
ipam.ipamPrefixesRead
ipam.ipamPrefixesUpdate
ipam.ipamRirsCreate
ipam.ipamRirsDelete
ipam.ipamRirsList
ipam.ipamRirsPartialUpdate
ipam.ipamRirsRead
ipam.ipamRirsUpdate
ipam.ipamRolesCreate
ipam.ipamRolesDelete
ipam.ipamRolesList
ipam.ipamRolesPartialUpdate
ipam.ipamRolesRead
ipam.ipamRolesUpdate
ipam.ipamServicesCreate
ipam.ipamServicesDelete
ipam.ipamServicesList
ipam.ipamServicesPartialUpdate
ipam.ipamServicesRead
ipam.ipamServicesUpdate
ipam.ipamVlanGroupsCreate
ipam.ipamVlanGroupsDelete
ipam.ipamVlanGroupsList
ipam.ipamVlanGroupsPartialUpdate
ipam.ipamVlanGroupsRead
ipam.ipamVlanGroupsUpdate
ipam.ipamVlansCreate
ipam.ipamVlansDelete
ipam.ipamVlansList
ipam.ipamVlansPartialUpdate
ipam.ipamVlansRead
ipam.ipamVlansUpdate
ipam.ipamVrfsCreate
ipam.ipamVrfsDelete
ipam.ipamVrfsList
ipam.ipamVrfsPartialUpdate
ipam.ipamVrfsRead
ipam.ipamVrfsUpdate
secrets.secretsChoicesList
secrets.secretsChoicesRead
secrets.secretsGenerateRsaKeyPairList
This endpoint can be used to generate a new RSA key pair. The keys are returned in PEM format.
{ "public_key": "<public key>", "private_key": "<private key>"}
secrets.secretsGetSessionKeyCreate
Retrieve a temporary session key to use for encrypting and decrypting secrets via the API. The user's private RSA key is POSTed with the name private_key. An example:
curl -v -X POST -H "Authorization: Token <token>" -H "Accept: application/json; indent=4" \--data-urlencode "private_key@<filename>" https://netbox/api/secrets/get-session-key/
This request will yield a base64-encoded session key to be included in an X-Session-Key header in future requests:
{ "session_key": "+8t4SI6XikgVmB5+/urhozx9O5qCQANyOk1MNe6taRf="}
This endpoint accepts one optional parameter: preserve_key. If True and a session key exists, the existing session key will be returned instead of a new one.
secrets.secretsSecretRolesCreate
secrets.secretsSecretRolesDelete
secrets.secretsSecretRolesList
secrets.secretsSecretRolesPartialUpdate
secrets.secretsSecretRolesRead
secrets.secretsSecretRolesUpdate
secrets.secretsSecretsCreate
secrets.secretsSecretsDelete
secrets.secretsSecretsList
secrets.secretsSecretsPartialUpdate
secrets.secretsSecretsRead
secrets.secretsSecretsUpdate
tenancy.tenancyChoicesList
tenancy.tenancyChoicesRead
tenancy.tenancyTenantGroupsCreate
tenancy.tenancyTenantGroupsDelete
tenancy.tenancyTenantGroupsList
tenancy.tenancyTenantGroupsPartialUpdate
tenancy.tenancyTenantGroupsRead
tenancy.tenancyTenantGroupsUpdate
tenancy.tenancyTenantsCreate
tenancy.tenancyTenantsDelete
tenancy.tenancyTenantsList
tenancy.tenancyTenantsPartialUpdate
tenancy.tenancyTenantsRead
tenancy.tenancyTenantsUpdate
virtualization.virtualizationChoicesList
virtualization.virtualizationChoicesRead
virtualization.virtualizationClusterGroupsCreate
virtualization.virtualizationClusterGroupsDelete
virtualization.virtualizationClusterGroupsList
virtualization.virtualizationClusterGroupsPartialUpdate
virtualization.virtualizationClusterGroupsRead
virtualization.virtualizationClusterGroupsUpdate
virtualization.virtualizationClustersCreate
virtualization.virtualizationClustersDelete
virtualization.virtualizationClustersList
virtualization.virtualizationClustersPartialUpdate
virtualization.virtualizationClustersRead
virtualization.virtualizationClustersUpdate
virtualization.virtualizationClusterTypesCreate
virtualization.virtualizationClusterTypesDelete
virtualization.virtualizationClusterTypesList
virtualization.virtualizationClusterTypesPartialUpdate
virtualization.virtualizationClusterTypesRead
virtualization.virtualizationClusterTypesUpdate
virtualization.virtualizationInterfacesCreate
virtualization.virtualizationInterfacesDelete
virtualization.virtualizationInterfacesList
virtualization.virtualizationInterfacesPartialUpdate
virtualization.virtualizationInterfacesRead
virtualization.virtualizationInterfacesUpdate
virtualization.virtualizationVirtualMachinesCreate
virtualization.virtualizationVirtualMachinesDelete
virtualization.virtualizationVirtualMachinesList
virtualization.virtualizationVirtualMachinesPartialUpdate
virtualization.virtualizationVirtualMachinesRead
virtualization.virtualizationVirtualMachinesUpdate
openapi.previewSpec

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

Add an OpenAPI source and register its operations as tools