Skip to content

nrfta/python-netbox-client

BranchesTags

Repository files navigation

netbox-client

API to access NetBox

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.8
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/nrfta/python-netbox-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/nrfta/python-netbox-client.git)

Then import the package:

import netbox_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import netbox_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import netbox_client
from netbox_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
configuration = netbox_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = netbox_client.CircuitsApi(netbox_client.ApiClient(configuration))
data = netbox_client.WritableCircuitTermination() # WritableCircuitTermination | 

try:
    api_response = api_instance.circuits_circuit_terminations_create(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CircuitsApi->circuits_circuit_terminations_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://netbox/api

Class Method HTTP request Description
CircuitsApi circuits_circuit_terminations_create POST /circuits/circuit-terminations/
CircuitsApi circuits_circuit_terminations_delete DELETE /circuits/circuit-terminations/{id}/
CircuitsApi circuits_circuit_terminations_list GET /circuits/circuit-terminations/
CircuitsApi circuits_circuit_terminations_partial_update PATCH /circuits/circuit-terminations/{id}/
CircuitsApi circuits_circuit_terminations_read GET /circuits/circuit-terminations/{id}/
CircuitsApi circuits_circuit_terminations_update PUT /circuits/circuit-terminations/{id}/
CircuitsApi circuits_circuit_types_create POST /circuits/circuit-types/
CircuitsApi circuits_circuit_types_delete DELETE /circuits/circuit-types/{id}/
CircuitsApi circuits_circuit_types_list GET /circuits/circuit-types/
CircuitsApi circuits_circuit_types_partial_update PATCH /circuits/circuit-types/{id}/
CircuitsApi circuits_circuit_types_read GET /circuits/circuit-types/{id}/
CircuitsApi circuits_circuit_types_update PUT /circuits/circuit-types/{id}/
CircuitsApi circuits_circuits_create POST /circuits/circuits/
CircuitsApi circuits_circuits_delete DELETE /circuits/circuits/{id}/
CircuitsApi circuits_circuits_list GET /circuits/circuits/
CircuitsApi circuits_circuits_partial_update PATCH /circuits/circuits/{id}/
CircuitsApi circuits_circuits_read GET /circuits/circuits/{id}/
CircuitsApi circuits_circuits_update PUT /circuits/circuits/{id}/
CircuitsApi circuits_providers_create POST /circuits/providers/
CircuitsApi circuits_providers_delete DELETE /circuits/providers/{id}/
CircuitsApi circuits_providers_graphs GET /circuits/providers/{id}/graphs/
CircuitsApi circuits_providers_list GET /circuits/providers/
CircuitsApi circuits_providers_partial_update PATCH /circuits/providers/{id}/
CircuitsApi circuits_providers_read GET /circuits/providers/{id}/
CircuitsApi circuits_providers_update PUT /circuits/providers/{id}/
DcimApi dcim_cables_create POST /dcim/cables/
DcimApi dcim_cables_delete DELETE /dcim/cables/{id}/
DcimApi dcim_cables_list GET /dcim/cables/
DcimApi dcim_cables_partial_update PATCH /dcim/cables/{id}/
DcimApi dcim_cables_read GET /dcim/cables/{id}/
DcimApi dcim_cables_update PUT /dcim/cables/{id}/
DcimApi dcim_connected_device_list GET /dcim/connected-device/
DcimApi dcim_console_connections_list GET /dcim/console-connections/
DcimApi dcim_console_port_templates_create POST /dcim/console-port-templates/
DcimApi dcim_console_port_templates_delete DELETE /dcim/console-port-templates/{id}/
DcimApi dcim_console_port_templates_list GET /dcim/console-port-templates/
DcimApi dcim_console_port_templates_partial_update PATCH /dcim/console-port-templates/{id}/
DcimApi dcim_console_port_templates_read GET /dcim/console-port-templates/{id}/
DcimApi dcim_console_port_templates_update PUT /dcim/console-port-templates/{id}/
DcimApi dcim_console_ports_create POST /dcim/console-ports/
DcimApi dcim_console_ports_delete DELETE /dcim/console-ports/{id}/
DcimApi dcim_console_ports_list GET /dcim/console-ports/
DcimApi dcim_console_ports_partial_update PATCH /dcim/console-ports/{id}/
DcimApi dcim_console_ports_read GET /dcim/console-ports/{id}/
DcimApi dcim_console_ports_trace GET /dcim/console-ports/{id}/trace/
DcimApi dcim_console_ports_update PUT /dcim/console-ports/{id}/
DcimApi dcim_console_server_port_templates_create POST /dcim/console-server-port-templates/
DcimApi dcim_console_server_port_templates_delete DELETE /dcim/console-server-port-templates/{id}/
DcimApi dcim_console_server_port_templates_list GET /dcim/console-server-port-templates/
DcimApi dcim_console_server_port_templates_partial_update PATCH /dcim/console-server-port-templates/{id}/
DcimApi dcim_console_server_port_templates_read GET /dcim/console-server-port-templates/{id}/
DcimApi dcim_console_server_port_templates_update PUT /dcim/console-server-port-templates/{id}/
DcimApi dcim_console_server_ports_create POST /dcim/console-server-ports/
DcimApi dcim_console_server_ports_delete DELETE /dcim/console-server-ports/{id}/
DcimApi dcim_console_server_ports_list GET /dcim/console-server-ports/
DcimApi dcim_console_server_ports_partial_update PATCH /dcim/console-server-ports/{id}/
DcimApi dcim_console_server_ports_read GET /dcim/console-server-ports/{id}/
DcimApi dcim_console_server_ports_trace GET /dcim/console-server-ports/{id}/trace/
DcimApi dcim_console_server_ports_update PUT /dcim/console-server-ports/{id}/
DcimApi dcim_device_bay_templates_create POST /dcim/device-bay-templates/
DcimApi dcim_device_bay_templates_delete DELETE /dcim/device-bay-templates/{id}/
DcimApi dcim_device_bay_templates_list GET /dcim/device-bay-templates/
DcimApi dcim_device_bay_templates_partial_update PATCH /dcim/device-bay-templates/{id}/
DcimApi dcim_device_bay_templates_read GET /dcim/device-bay-templates/{id}/
DcimApi dcim_device_bay_templates_update PUT /dcim/device-bay-templates/{id}/
DcimApi dcim_device_bays_create POST /dcim/device-bays/
DcimApi dcim_device_bays_delete DELETE /dcim/device-bays/{id}/
DcimApi dcim_device_bays_list GET /dcim/device-bays/
DcimApi dcim_device_bays_partial_update PATCH /dcim/device-bays/{id}/
DcimApi dcim_device_bays_read GET /dcim/device-bays/{id}/
DcimApi dcim_device_bays_update PUT /dcim/device-bays/{id}/
DcimApi dcim_device_roles_create POST /dcim/device-roles/
DcimApi dcim_device_roles_delete DELETE /dcim/device-roles/{id}/
DcimApi dcim_device_roles_list GET /dcim/device-roles/
DcimApi dcim_device_roles_partial_update PATCH /dcim/device-roles/{id}/
DcimApi dcim_device_roles_read GET /dcim/device-roles/{id}/
DcimApi dcim_device_roles_update PUT /dcim/device-roles/{id}/
DcimApi dcim_device_types_create POST /dcim/device-types/
DcimApi dcim_device_types_delete DELETE /dcim/device-types/{id}/
DcimApi dcim_device_types_list GET /dcim/device-types/
DcimApi dcim_device_types_partial_update PATCH /dcim/device-types/{id}/
DcimApi dcim_device_types_read GET /dcim/device-types/{id}/
DcimApi dcim_device_types_update PUT /dcim/device-types/{id}/
DcimApi dcim_devices_create POST /dcim/devices/
DcimApi dcim_devices_delete DELETE /dcim/devices/{id}/
DcimApi dcim_devices_graphs GET /dcim/devices/{id}/graphs/
DcimApi dcim_devices_list GET /dcim/devices/
DcimApi dcim_devices_napalm GET /dcim/devices/{id}/napalm/
DcimApi dcim_devices_partial_update PATCH /dcim/devices/{id}/
DcimApi dcim_devices_read GET /dcim/devices/{id}/
DcimApi dcim_devices_update PUT /dcim/devices/{id}/
DcimApi dcim_front_port_templates_create POST /dcim/front-port-templates/
DcimApi dcim_front_port_templates_delete DELETE /dcim/front-port-templates/{id}/
DcimApi dcim_front_port_templates_list GET /dcim/front-port-templates/
DcimApi dcim_front_port_templates_partial_update PATCH /dcim/front-port-templates/{id}/
DcimApi dcim_front_port_templates_read GET /dcim/front-port-templates/{id}/
DcimApi dcim_front_port_templates_update PUT /dcim/front-port-templates/{id}/
DcimApi dcim_front_ports_create POST /dcim/front-ports/
DcimApi dcim_front_ports_delete DELETE /dcim/front-ports/{id}/
DcimApi dcim_front_ports_list GET /dcim/front-ports/
DcimApi dcim_front_ports_partial_update PATCH /dcim/front-ports/{id}/
DcimApi dcim_front_ports_read GET /dcim/front-ports/{id}/
DcimApi dcim_front_ports_update PUT /dcim/front-ports/{id}/
DcimApi dcim_interface_connections_list GET /dcim/interface-connections/
DcimApi dcim_interface_templates_create POST /dcim/interface-templates/
DcimApi dcim_interface_templates_delete DELETE /dcim/interface-templates/{id}/
DcimApi dcim_interface_templates_list GET /dcim/interface-templates/
DcimApi dcim_interface_templates_partial_update PATCH /dcim/interface-templates/{id}/
DcimApi dcim_interface_templates_read GET /dcim/interface-templates/{id}/
DcimApi dcim_interface_templates_update PUT /dcim/interface-templates/{id}/
DcimApi dcim_interfaces_create POST /dcim/interfaces/
DcimApi dcim_interfaces_delete DELETE /dcim/interfaces/{id}/
DcimApi dcim_interfaces_graphs GET /dcim/interfaces/{id}/graphs/
DcimApi dcim_interfaces_list GET /dcim/interfaces/
DcimApi dcim_interfaces_partial_update PATCH /dcim/interfaces/{id}/
DcimApi dcim_interfaces_read GET /dcim/interfaces/{id}/
DcimApi dcim_interfaces_trace GET /dcim/interfaces/{id}/trace/
DcimApi dcim_interfaces_update PUT /dcim/interfaces/{id}/
DcimApi dcim_inventory_items_create POST /dcim/inventory-items/
DcimApi dcim_inventory_items_delete DELETE /dcim/inventory-items/{id}/
DcimApi dcim_inventory_items_list GET /dcim/inventory-items/
DcimApi dcim_inventory_items_partial_update PATCH /dcim/inventory-items/{id}/
DcimApi dcim_inventory_items_read GET /dcim/inventory-items/{id}/
DcimApi dcim_inventory_items_update PUT /dcim/inventory-items/{id}/
DcimApi dcim_manufacturers_create POST /dcim/manufacturers/
DcimApi dcim_manufacturers_delete DELETE /dcim/manufacturers/{id}/
DcimApi dcim_manufacturers_list GET /dcim/manufacturers/
DcimApi dcim_manufacturers_partial_update PATCH /dcim/manufacturers/{id}/
DcimApi dcim_manufacturers_read GET /dcim/manufacturers/{id}/
DcimApi dcim_manufacturers_update PUT /dcim/manufacturers/{id}/
DcimApi dcim_platforms_create POST /dcim/platforms/
DcimApi dcim_platforms_delete DELETE /dcim/platforms/{id}/
DcimApi dcim_platforms_list GET /dcim/platforms/
DcimApi dcim_platforms_partial_update PATCH /dcim/platforms/{id}/
DcimApi dcim_platforms_read GET /dcim/platforms/{id}/
DcimApi dcim_platforms_update PUT /dcim/platforms/{id}/
DcimApi dcim_power_connections_list GET /dcim/power-connections/
DcimApi dcim_power_feeds_create POST /dcim/power-feeds/
DcimApi dcim_power_feeds_delete DELETE /dcim/power-feeds/{id}/
DcimApi dcim_power_feeds_list GET /dcim/power-feeds/
DcimApi dcim_power_feeds_partial_update PATCH /dcim/power-feeds/{id}/
DcimApi dcim_power_feeds_read GET /dcim/power-feeds/{id}/
DcimApi dcim_power_feeds_update PUT /dcim/power-feeds/{id}/
DcimApi dcim_power_outlet_templates_create POST /dcim/power-outlet-templates/
DcimApi dcim_power_outlet_templates_delete DELETE /dcim/power-outlet-templates/{id}/
DcimApi dcim_power_outlet_templates_list GET /dcim/power-outlet-templates/
DcimApi dcim_power_outlet_templates_partial_update PATCH /dcim/power-outlet-templates/{id}/
DcimApi dcim_power_outlet_templates_read GET /dcim/power-outlet-templates/{id}/
DcimApi dcim_power_outlet_templates_update PUT /dcim/power-outlet-templates/{id}/
DcimApi dcim_power_outlets_create POST /dcim/power-outlets/
DcimApi dcim_power_outlets_delete DELETE /dcim/power-outlets/{id}/
DcimApi dcim_power_outlets_list GET /dcim/power-outlets/
DcimApi dcim_power_outlets_partial_update PATCH /dcim/power-outlets/{id}/
DcimApi dcim_power_outlets_read GET /dcim/power-outlets/{id}/
DcimApi dcim_power_outlets_trace GET /dcim/power-outlets/{id}/trace/
DcimApi dcim_power_outlets_update PUT /dcim/power-outlets/{id}/
DcimApi dcim_power_panels_create POST /dcim/power-panels/
DcimApi dcim_power_panels_delete DELETE /dcim/power-panels/{id}/
DcimApi dcim_power_panels_list GET /dcim/power-panels/
DcimApi dcim_power_panels_partial_update PATCH /dcim/power-panels/{id}/
DcimApi dcim_power_panels_read GET /dcim/power-panels/{id}/
DcimApi dcim_power_panels_update PUT /dcim/power-panels/{id}/
DcimApi dcim_power_port_templates_create POST /dcim/power-port-templates/
DcimApi dcim_power_port_templates_delete DELETE /dcim/power-port-templates/{id}/
DcimApi dcim_power_port_templates_list GET /dcim/power-port-templates/
DcimApi dcim_power_port_templates_partial_update PATCH /dcim/power-port-templates/{id}/
DcimApi dcim_power_port_templates_read GET /dcim/power-port-templates/{id}/
DcimApi dcim_power_port_templates_update PUT /dcim/power-port-templates/{id}/
DcimApi dcim_power_ports_create POST /dcim/power-ports/
DcimApi dcim_power_ports_delete DELETE /dcim/power-ports/{id}/
DcimApi dcim_power_ports_list GET /dcim/power-ports/
DcimApi dcim_power_ports_partial_update PATCH /dcim/power-ports/{id}/
DcimApi dcim_power_ports_read GET /dcim/power-ports/{id}/
DcimApi dcim_power_ports_trace GET /dcim/power-ports/{id}/trace/
DcimApi dcim_power_ports_update PUT /dcim/power-ports/{id}/
DcimApi dcim_rack_groups_create POST /dcim/rack-groups/
DcimApi dcim_rack_groups_delete DELETE /dcim/rack-groups/{id}/
DcimApi dcim_rack_groups_list GET /dcim/rack-groups/
DcimApi dcim_rack_groups_partial_update PATCH /dcim/rack-groups/{id}/
DcimApi dcim_rack_groups_read GET /dcim/rack-groups/{id}/
DcimApi dcim_rack_groups_update PUT /dcim/rack-groups/{id}/
DcimApi dcim_rack_reservations_create POST /dcim/rack-reservations/
DcimApi dcim_rack_reservations_delete DELETE /dcim/rack-reservations/{id}/
DcimApi dcim_rack_reservations_list GET /dcim/rack-reservations/
DcimApi dcim_rack_reservations_partial_update PATCH /dcim/rack-reservations/{id}/
DcimApi dcim_rack_reservations_read GET /dcim/rack-reservations/{id}/
DcimApi dcim_rack_reservations_update PUT /dcim/rack-reservations/{id}/
DcimApi dcim_rack_roles_create POST /dcim/rack-roles/
DcimApi dcim_rack_roles_delete DELETE /dcim/rack-roles/{id}/
DcimApi dcim_rack_roles_list GET /dcim/rack-roles/
DcimApi dcim_rack_roles_partial_update PATCH /dcim/rack-roles/{id}/
DcimApi dcim_rack_roles_read GET /dcim/rack-roles/{id}/
DcimApi dcim_rack_roles_update PUT /dcim/rack-roles/{id}/
DcimApi dcim_racks_create POST /dcim/racks/
DcimApi dcim_racks_delete DELETE /dcim/racks/{id}/
DcimApi dcim_racks_elevation GET /dcim/racks/{id}/elevation/
DcimApi dcim_racks_list GET /dcim/racks/
DcimApi dcim_racks_partial_update PATCH /dcim/racks/{id}/
DcimApi dcim_racks_read GET /dcim/racks/{id}/
DcimApi dcim_racks_update PUT /dcim/racks/{id}/
DcimApi dcim_rear_port_templates_create POST /dcim/rear-port-templates/
DcimApi dcim_rear_port_templates_delete DELETE /dcim/rear-port-templates/{id}/
DcimApi dcim_rear_port_templates_list GET /dcim/rear-port-templates/
DcimApi dcim_rear_port_templates_partial_update PATCH /dcim/rear-port-templates/{id}/
DcimApi dcim_rear_port_templates_read GET /dcim/rear-port-templates/{id}/
DcimApi dcim_rear_port_templates_update PUT /dcim/rear-port-templates/{id}/
DcimApi dcim_rear_ports_create POST /dcim/rear-ports/
DcimApi dcim_rear_ports_delete DELETE /dcim/rear-ports/{id}/
DcimApi dcim_rear_ports_list GET /dcim/rear-ports/
DcimApi dcim_rear_ports_partial_update PATCH /dcim/rear-ports/{id}/
DcimApi dcim_rear_ports_read GET /dcim/rear-ports/{id}/
DcimApi dcim_rear_ports_update PUT /dcim/rear-ports/{id}/
DcimApi dcim_regions_create POST /dcim/regions/
DcimApi dcim_regions_delete DELETE /dcim/regions/{id}/
DcimApi dcim_regions_list GET /dcim/regions/
DcimApi dcim_regions_partial_update PATCH /dcim/regions/{id}/
DcimApi dcim_regions_read GET /dcim/regions/{id}/
DcimApi dcim_regions_update PUT /dcim/regions/{id}/
DcimApi dcim_sites_create POST /dcim/sites/
DcimApi dcim_sites_delete DELETE /dcim/sites/{id}/
DcimApi dcim_sites_graphs GET /dcim/sites/{id}/graphs/
DcimApi dcim_sites_list GET /dcim/sites/
DcimApi dcim_sites_partial_update PATCH /dcim/sites/{id}/
DcimApi dcim_sites_read GET /dcim/sites/{id}/
DcimApi dcim_sites_update PUT /dcim/sites/{id}/
DcimApi dcim_virtual_chassis_create POST /dcim/virtual-chassis/
DcimApi dcim_virtual_chassis_delete DELETE /dcim/virtual-chassis/{id}/
DcimApi dcim_virtual_chassis_list GET /dcim/virtual-chassis/
DcimApi dcim_virtual_chassis_partial_update PATCH /dcim/virtual-chassis/{id}/
DcimApi dcim_virtual_chassis_read GET /dcim/virtual-chassis/{id}/
DcimApi dcim_virtual_chassis_update PUT /dcim/virtual-chassis/{id}/
ExtrasApi extras_config_contexts_create POST /extras/config-contexts/
ExtrasApi extras_config_contexts_delete DELETE /extras/config-contexts/{id}/
ExtrasApi extras_config_contexts_list GET /extras/config-contexts/
ExtrasApi extras_config_contexts_partial_update PATCH /extras/config-contexts/{id}/
ExtrasApi extras_config_contexts_read GET /extras/config-contexts/{id}/
ExtrasApi extras_config_contexts_update PUT /extras/config-contexts/{id}/
ExtrasApi extras_custom_field_choices_list GET /extras/_custom_field_choices/
ExtrasApi extras_custom_field_choices_read GET /extras/_custom_field_choices/{id}/
ExtrasApi extras_export_templates_create POST /extras/export-templates/
ExtrasApi extras_export_templates_delete DELETE /extras/export-templates/{id}/
ExtrasApi extras_export_templates_list GET /extras/export-templates/
ExtrasApi extras_export_templates_partial_update PATCH /extras/export-templates/{id}/
ExtrasApi extras_export_templates_read GET /extras/export-templates/{id}/
ExtrasApi extras_export_templates_update PUT /extras/export-templates/{id}/
ExtrasApi extras_graphs_create POST /extras/graphs/
ExtrasApi extras_graphs_delete DELETE /extras/graphs/{id}/
ExtrasApi extras_graphs_list GET /extras/graphs/
ExtrasApi extras_graphs_partial_update PATCH /extras/graphs/{id}/
ExtrasApi extras_graphs_read GET /extras/graphs/{id}/
ExtrasApi extras_graphs_update PUT /extras/graphs/{id}/
ExtrasApi extras_image_attachments_create POST /extras/image-attachments/
ExtrasApi extras_image_attachments_delete DELETE /extras/image-attachments/{id}/
ExtrasApi extras_image_attachments_list GET /extras/image-attachments/
ExtrasApi extras_image_attachments_partial_update PATCH /extras/image-attachments/{id}/
ExtrasApi extras_image_attachments_read GET /extras/image-attachments/{id}/
ExtrasApi extras_image_attachments_update PUT /extras/image-attachments/{id}/
ExtrasApi extras_object_changes_list GET /extras/object-changes/
ExtrasApi extras_object_changes_read GET /extras/object-changes/{id}/
ExtrasApi extras_reports_list GET /extras/reports/
ExtrasApi extras_reports_read GET /extras/reports/{id}/
ExtrasApi extras_reports_run POST /extras/reports/{id}/run/
ExtrasApi extras_scripts_list GET /extras/scripts/
ExtrasApi extras_scripts_read GET /extras/scripts/{id}/
ExtrasApi extras_tags_create POST /extras/tags/
ExtrasApi extras_tags_delete DELETE /extras/tags/{id}/
ExtrasApi extras_tags_list GET /extras/tags/
ExtrasApi extras_tags_partial_update PATCH /extras/tags/{id}/
ExtrasApi extras_tags_read GET /extras/tags/{id}/
ExtrasApi extras_tags_update PUT /extras/tags/{id}/
IpamApi ipam_aggregates_create POST /ipam/aggregates/
IpamApi ipam_aggregates_delete DELETE /ipam/aggregates/{id}/
IpamApi ipam_aggregates_list GET /ipam/aggregates/
IpamApi ipam_aggregates_partial_update PATCH /ipam/aggregates/{id}/
IpamApi ipam_aggregates_read GET /ipam/aggregates/{id}/
IpamApi ipam_aggregates_update PUT /ipam/aggregates/{id}/
IpamApi ipam_ip_addresses_create POST /ipam/ip-addresses/
IpamApi ipam_ip_addresses_delete DELETE /ipam/ip-addresses/{id}/
IpamApi ipam_ip_addresses_list GET /ipam/ip-addresses/
IpamApi ipam_ip_addresses_partial_update PATCH /ipam/ip-addresses/{id}/
IpamApi ipam_ip_addresses_read GET /ipam/ip-addresses/{id}/
IpamApi ipam_ip_addresses_update PUT /ipam/ip-addresses/{id}/
IpamApi ipam_prefixes_available_ips_create POST /ipam/prefixes/{id}/available-ips/
IpamApi ipam_prefixes_available_ips_read GET /ipam/prefixes/{id}/available-ips/
IpamApi ipam_prefixes_available_prefixes_create POST /ipam/prefixes/{id}/available-prefixes/ A convenience method for returning available child prefixes within a parent.
IpamApi ipam_prefixes_available_prefixes_read GET /ipam/prefixes/{id}/available-prefixes/ A convenience method for returning available child prefixes within a parent.
IpamApi ipam_prefixes_create POST /ipam/prefixes/
IpamApi ipam_prefixes_delete DELETE /ipam/prefixes/{id}/
IpamApi ipam_prefixes_list GET /ipam/prefixes/
IpamApi ipam_prefixes_partial_update PATCH /ipam/prefixes/{id}/
IpamApi ipam_prefixes_read GET /ipam/prefixes/{id}/
IpamApi ipam_prefixes_update PUT /ipam/prefixes/{id}/
IpamApi ipam_rirs_create POST /ipam/rirs/
IpamApi ipam_rirs_delete DELETE /ipam/rirs/{id}/
IpamApi ipam_rirs_list GET /ipam/rirs/
IpamApi ipam_rirs_partial_update PATCH /ipam/rirs/{id}/
IpamApi ipam_rirs_read GET /ipam/rirs/{id}/
IpamApi ipam_rirs_update PUT /ipam/rirs/{id}/
IpamApi ipam_roles_create POST /ipam/roles/
IpamApi ipam_roles_delete DELETE /ipam/roles/{id}/
IpamApi ipam_roles_list GET /ipam/roles/
IpamApi ipam_roles_partial_update PATCH /ipam/roles/{id}/
IpamApi ipam_roles_read GET /ipam/roles/{id}/
IpamApi ipam_roles_update PUT /ipam/roles/{id}/
IpamApi ipam_services_create POST /ipam/services/
IpamApi ipam_services_delete DELETE /ipam/services/{id}/
IpamApi ipam_services_list GET /ipam/services/
IpamApi ipam_services_partial_update PATCH /ipam/services/{id}/
IpamApi ipam_services_read GET /ipam/services/{id}/
IpamApi ipam_services_update PUT /ipam/services/{id}/
IpamApi ipam_vlan_groups_create POST /ipam/vlan-groups/
IpamApi ipam_vlan_groups_delete DELETE /ipam/vlan-groups/{id}/
IpamApi ipam_vlan_groups_list GET /ipam/vlan-groups/
IpamApi ipam_vlan_groups_partial_update PATCH /ipam/vlan-groups/{id}/
IpamApi ipam_vlan_groups_read GET /ipam/vlan-groups/{id}/
IpamApi ipam_vlan_groups_update PUT /ipam/vlan-groups/{id}/
IpamApi ipam_vlans_create POST /ipam/vlans/
IpamApi ipam_vlans_delete DELETE /ipam/vlans/{id}/
IpamApi ipam_vlans_list GET /ipam/vlans/
IpamApi ipam_vlans_partial_update PATCH /ipam/vlans/{id}/
IpamApi ipam_vlans_read GET /ipam/vlans/{id}/
IpamApi ipam_vlans_update PUT /ipam/vlans/{id}/
IpamApi ipam_vrfs_create POST /ipam/vrfs/
IpamApi ipam_vrfs_delete DELETE /ipam/vrfs/{id}/
IpamApi ipam_vrfs_list GET /ipam/vrfs/
IpamApi ipam_vrfs_partial_update PATCH /ipam/vrfs/{id}/
IpamApi ipam_vrfs_read GET /ipam/vrfs/{id}/
IpamApi ipam_vrfs_update PUT /ipam/vrfs/{id}/
SecretsApi secrets_generate_rsa_key_pair_list GET /secrets/generate-rsa-key-pair/ This endpoint can be used to generate a new RSA key pair. The keys are returned in PEM format.
SecretsApi secrets_get_session_key_create POST /secrets/get-session-key/
SecretsApi secrets_secret_roles_create POST /secrets/secret-roles/
SecretsApi secrets_secret_roles_delete DELETE /secrets/secret-roles/{id}/
SecretsApi secrets_secret_roles_list GET /secrets/secret-roles/
SecretsApi secrets_secret_roles_partial_update PATCH /secrets/secret-roles/{id}/
SecretsApi secrets_secret_roles_read GET /secrets/secret-roles/{id}/
SecretsApi secrets_secret_roles_update PUT /secrets/secret-roles/{id}/
SecretsApi secrets_secrets_create POST /secrets/secrets/
SecretsApi secrets_secrets_delete DELETE /secrets/secrets/{id}/
SecretsApi secrets_secrets_list GET /secrets/secrets/
SecretsApi secrets_secrets_partial_update PATCH /secrets/secrets/{id}/
SecretsApi secrets_secrets_read GET /secrets/secrets/{id}/
SecretsApi secrets_secrets_update PUT /secrets/secrets/{id}/
TenancyApi tenancy_tenant_groups_create POST /tenancy/tenant-groups/
TenancyApi tenancy_tenant_groups_delete DELETE /tenancy/tenant-groups/{id}/
TenancyApi tenancy_tenant_groups_list GET /tenancy/tenant-groups/
TenancyApi tenancy_tenant_groups_partial_update PATCH /tenancy/tenant-groups/{id}/
TenancyApi tenancy_tenant_groups_read GET /tenancy/tenant-groups/{id}/
TenancyApi tenancy_tenant_groups_update PUT /tenancy/tenant-groups/{id}/
TenancyApi tenancy_tenants_create POST /tenancy/tenants/
TenancyApi tenancy_tenants_delete DELETE /tenancy/tenants/{id}/
TenancyApi tenancy_tenants_list GET /tenancy/tenants/
TenancyApi tenancy_tenants_partial_update PATCH /tenancy/tenants/{id}/
TenancyApi tenancy_tenants_read GET /tenancy/tenants/{id}/
TenancyApi tenancy_tenants_update PUT /tenancy/tenants/{id}/
VirtualizationApi virtualization_cluster_groups_create POST /virtualization/cluster-groups/
VirtualizationApi virtualization_cluster_groups_delete DELETE /virtualization/cluster-groups/{id}/
VirtualizationApi virtualization_cluster_groups_list GET /virtualization/cluster-groups/
VirtualizationApi virtualization_cluster_groups_partial_update PATCH /virtualization/cluster-groups/{id}/
VirtualizationApi virtualization_cluster_groups_read GET /virtualization/cluster-groups/{id}/
VirtualizationApi virtualization_cluster_groups_update PUT /virtualization/cluster-groups/{id}/
VirtualizationApi virtualization_cluster_types_create POST /virtualization/cluster-types/
VirtualizationApi virtualization_cluster_types_delete DELETE /virtualization/cluster-types/{id}/
VirtualizationApi virtualization_cluster_types_list GET /virtualization/cluster-types/
VirtualizationApi virtualization_cluster_types_partial_update PATCH /virtualization/cluster-types/{id}/
VirtualizationApi virtualization_cluster_types_read GET /virtualization/cluster-types/{id}/
VirtualizationApi virtualization_cluster_types_update PUT /virtualization/cluster-types/{id}/
VirtualizationApi virtualization_clusters_create POST /virtualization/clusters/
VirtualizationApi virtualization_clusters_delete DELETE /virtualization/clusters/{id}/
VirtualizationApi virtualization_clusters_list GET /virtualization/clusters/
VirtualizationApi virtualization_clusters_partial_update PATCH /virtualization/clusters/{id}/
VirtualizationApi virtualization_clusters_read GET /virtualization/clusters/{id}/
VirtualizationApi virtualization_clusters_update PUT /virtualization/clusters/{id}/
VirtualizationApi virtualization_interfaces_create POST /virtualization/interfaces/
VirtualizationApi virtualization_interfaces_delete DELETE /virtualization/interfaces/{id}/
VirtualizationApi virtualization_interfaces_list GET /virtualization/interfaces/
VirtualizationApi virtualization_interfaces_partial_update PATCH /virtualization/interfaces/{id}/
VirtualizationApi virtualization_interfaces_read GET /virtualization/interfaces/{id}/
VirtualizationApi virtualization_interfaces_update PUT /virtualization/interfaces/{id}/
VirtualizationApi virtualization_virtual_machines_create POST /virtualization/virtual-machines/
VirtualizationApi virtualization_virtual_machines_delete DELETE /virtualization/virtual-machines/{id}/
VirtualizationApi virtualization_virtual_machines_list GET /virtualization/virtual-machines/
VirtualizationApi virtualization_virtual_machines_partial_update PATCH /virtualization/virtual-machines/{id}/
VirtualizationApi virtualization_virtual_machines_read GET /virtualization/virtual-machines/{id}/
VirtualizationApi virtualization_virtual_machines_update PUT /virtualization/virtual-machines/{id}/

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

About

Client library for NetBox

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

9 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages