3.0.0 • Published 5 years ago
@datafire/netboxdemo v3.0.0
@datafire/netboxdemo
Client library for NetBox API
Installation and Usage
npm install --save @datafire/netboxdemolet netboxdemo = require('@datafire/netboxdemo').create({
Bearer: ""
});
.then(data => {
console.log(data);
});Description
API to access NetBox
Actions
circuits.circuit_terminations.get
Call to super to allow for caching
netboxdemo.circuits.circuit_terminations.get({}, context)Input
- input
object- term_side
string - port_speed
string - upstream_speed
string - xconnect_id
string - q
string - circuit_id
string - site_id
string - site
string - term_side__n
string - port_speed__n
string - port_speed__lte
string - port_speed__lt
string - port_speed__gte
string - port_speed__gt
string - upstream_speed__n
string - upstream_speed__lte
string - upstream_speed__lt
string - upstream_speed__gte
string - upstream_speed__gt
string - xconnect_id__n
string - xconnect_id__ic
string - xconnect_id__nic
string - xconnect_id__iew
string - xconnect_id__niew
string - xconnect_id__isw
string - xconnect_id__nisw
string - xconnect_id__ie
string - xconnect_id__nie
string - circuit_id__n
string - site_id__n
string - site__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- term_side
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items CircuitTermination
- count required
circuits.circuit_terminations.post
netboxdemo.circuits.circuit_terminations.post({
"body": {
"circuit": 0,
"term_side": "",
"site": 0,
"port_speed": 0
}
}, context)Input
- input
object- body required WritableCircuitTermination
Output
- output CircuitTermination
circuits.circuit_terminations.id.delete
netboxdemo.circuits.circuit_terminations.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this circuit termination.
- id required
Output
Output schema unknown
circuits.circuit_terminations.id.get
Call to super to allow for caching
netboxdemo.circuits.circuit_terminations.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this circuit termination.
- id required
Output
- output CircuitTermination
circuits.circuit_terminations.id.patch
netboxdemo.circuits.circuit_terminations.id.patch({
"body": {
"circuit": 0,
"term_side": "",
"site": 0,
"port_speed": 0
},
"id": 0
}, context)Input
- input
object- body required WritableCircuitTermination
- id required
integer: A unique integer value identifying this circuit termination.
Output
- output CircuitTermination
circuits.circuit_terminations.id.put
netboxdemo.circuits.circuit_terminations.id.put({
"body": {
"circuit": 0,
"term_side": "",
"site": 0,
"port_speed": 0
},
"id": 0
}, context)Input
- input
object- body required WritableCircuitTermination
- id required
integer: A unique integer value identifying this circuit termination.
Output
- output CircuitTermination
circuits.circuit_types.get
Call to super to allow for caching
netboxdemo.circuits.circuit_types.get({}, context)Input
- input
object- id
string - name
string - slug
string - q
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - slug__n
string - slug__ic
string - slug__nic
string - slug__iew
string - slug__niew
string - slug__isw
string - slug__nisw
string - slug__ie
string - slug__nie
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items CircuitType
- count required
circuits.circuit_types.post
netboxdemo.circuits.circuit_types.post({
"body": {
"name": "",
"slug": ""
}
}, context)Input
- input
object- body required CircuitType
Output
- output CircuitType
circuits.circuit_types.id.delete
netboxdemo.circuits.circuit_types.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this circuit type.
- id required
Output
Output schema unknown
circuits.circuit_types.id.get
Call to super to allow for caching
netboxdemo.circuits.circuit_types.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this circuit type.
- id required
Output
- output CircuitType
circuits.circuit_types.id.patch
netboxdemo.circuits.circuit_types.id.patch({
"body": {
"name": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required CircuitType
- id required
integer: A unique integer value identifying this circuit type.
Output
- output CircuitType
circuits.circuit_types.id.put
netboxdemo.circuits.circuit_types.id.put({
"body": {
"name": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required CircuitType
- id required
integer: A unique integer value identifying this circuit type.
Output
- output CircuitType
circuits_circuits_list
Call to super to allow for caching
netboxdemo.circuits_circuits_list({}, context)Input
- input
object- id
string - cid
string - install_date
string - commit_rate
string - tenant_group_id
string - tenant_group
string - tenant_id
string - tenant
string - created
string - created__gte
string - created__lte
string - last_updated
string - last_updated__gte
string - last_updated__lte
string - q
string - provider_id
string - provider
string - type_id
string - type
string - status
string - site_id
string - site
string - region_id
string - region
string - tag
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - cid__n
string - cid__ic
string - cid__nic
string - cid__iew
string - cid__niew
string - cid__isw
string - cid__nisw
string - cid__ie
string - cid__nie
string - install_date__n
string - install_date__lte
string - install_date__lt
string - install_date__gte
string - install_date__gt
string - commit_rate__n
string - commit_rate__lte
string - commit_rate__lt
string - commit_rate__gte
string - commit_rate__gt
string - tenant_group_id__n
string - tenant_group__n
string - tenant_id__n
string - tenant__n
string - provider_id__n
string - provider__n
string - type_id__n
string - type__n
string - status__n
string - site_id__n
string - site__n
string - region_id__n
string - region__n
string - tag__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items Circuit
- count required
circuits_circuits_create
netboxdemo.circuits_circuits_create({
"body": {
"cid": "",
"provider": 0,
"type": 0
}
}, context)Input
- input
object- body required WritableCircuit
Output
- output Circuit
circuits_circuits_delete
netboxdemo.circuits_circuits_delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this circuit.
- id required
Output
Output schema unknown
circuits_circuits_read
Call to super to allow for caching
netboxdemo.circuits_circuits_read({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this circuit.
- id required
Output
- output Circuit
circuits_circuits_partial_update
netboxdemo.circuits_circuits_partial_update({
"body": {
"cid": "",
"provider": 0,
"type": 0
},
"id": 0
}, context)Input
- input
object- body required WritableCircuit
- id required
integer: A unique integer value identifying this circuit.
Output
- output Circuit
circuits_circuits_update
netboxdemo.circuits_circuits_update({
"body": {
"cid": "",
"provider": 0,
"type": 0
},
"id": 0
}, context)Input
- input
object- body required WritableCircuit
- id required
integer: A unique integer value identifying this circuit.
Output
- output Circuit
circuits_providers_list
Call to super to allow for caching
netboxdemo.circuits_providers_list({}, context)Input
- input
object- id
string - name
string - slug
string - asn
string - account
string - created
string - created__gte
string - created__lte
string - last_updated
string - last_updated__gte
string - last_updated__lte
string - q
string - region_id
string - region
string - site_id
string - site
string - tag
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - slug__n
string - slug__ic
string - slug__nic
string - slug__iew
string - slug__niew
string - slug__isw
string - slug__nisw
string - slug__ie
string - slug__nie
string - asn__n
string - asn__lte
string - asn__lt
string - asn__gte
string - asn__gt
string - account__n
string - account__ic
string - account__nic
string - account__iew
string - account__niew
string - account__isw
string - account__nisw
string - account__ie
string - account__nie
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - tag__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items Provider
- count required
circuits_providers_create
netboxdemo.circuits_providers_create({
"body": {
"name": "",
"slug": ""
}
}, context)Input
- input
object- body required Provider
Output
- output Provider
circuits_providers_delete
netboxdemo.circuits_providers_delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this provider.
- id required
Output
Output schema unknown
circuits_providers_read
Call to super to allow for caching
netboxdemo.circuits_providers_read({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this provider.
- id required
Output
- output Provider
circuits_providers_partial_update
netboxdemo.circuits_providers_partial_update({
"body": {
"name": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required Provider
- id required
integer: A unique integer value identifying this provider.
Output
- output Provider
circuits_providers_update
netboxdemo.circuits_providers_update({
"body": {
"name": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required Provider
- id required
integer: A unique integer value identifying this provider.
Output
- output Provider
circuits_providers_graphs
A convenience method for rendering graphs for a particular provider.
netboxdemo.circuits_providers_graphs({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this provider.
- id required
Output
- output Provider
dcim_cables_list
Call to super to allow for caching
netboxdemo.dcim_cables_list({}, context)Input
- input
object- id
string - label
string - length
string - length_unit
string - q
string - type
string - status
string - color
string - device_id
string - device
string - rack_id
string - rack
string - site_id
string - site
string - tenant_id
string - tenant
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - label__n
string - label__ic
string - label__nic
string - label__iew
string - label__niew
string - label__isw
string - label__nisw
string - label__ie
string - label__nie
string - length__n
string - length__lte
string - length__lt
string - length__gte
string - length__gt
string - length_unit__n
string - type__n
string - status__n
string - color__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items Cable
- count required
dcim_cables_create
netboxdemo.dcim_cables_create({
"body": {
"termination_a_type": "",
"termination_a_id": 0,
"termination_b_type": "",
"termination_b_id": 0
}
}, context)Input
- input
object- body required WritableCable
Output
- output Cable
dcim_cables_delete
netboxdemo.dcim_cables_delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this cable.
- id required
Output
Output schema unknown
dcim_cables_read
Call to super to allow for caching
netboxdemo.dcim_cables_read({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this cable.
- id required
Output
- output Cable
dcim_cables_partial_update
netboxdemo.dcim_cables_partial_update({
"body": {
"termination_a_type": "",
"termination_a_id": 0,
"termination_b_type": "",
"termination_b_id": 0
},
"id": 0
}, context)Input
- input
object- body required WritableCable
- id required
integer: A unique integer value identifying this cable.
Output
- output Cable
dcim_cables_update
netboxdemo.dcim_cables_update({
"body": {
"termination_a_type": "",
"termination_a_id": 0,
"termination_b_type": "",
"termination_b_id": 0
},
"id": 0
}, context)Input
- input
object- body required WritableCable
- id required
integer: A unique integer value identifying this cable.
Output
- output Cable
dcim.connected_device.get
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 devicepeer_interface: The name of the peer interface
netboxdemo.dcim.connected_device.get({
"peer_device": "",
"peer_interface": ""
}, context)Input
- input
object- peer_device required
string: The name of the peer device - peer_interface required
string: The name of the peer interface
- peer_device required
Output
- output Device
dcim.console_connections.get
netboxdemo.dcim.console_connections.get({}, context)Input
- input
object- name
string - connection_status
string - site
string - device_id
string - device
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - connection_status__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- name
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items ConsolePort
- count required
dcim.console_port_templates.get
Call to super to allow for caching
netboxdemo.dcim.console_port_templates.get({}, context)Input
- input
object- id
string - name
string - type
string - q
string - devicetype_id
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - type__n
string - devicetype_id__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items ConsolePortTemplate
- count required
dcim.console_port_templates.post
netboxdemo.dcim.console_port_templates.post({
"body": {
"device_type": 0,
"name": ""
}
}, context)Input
- input
object- body required WritableConsolePortTemplate
Output
- output ConsolePortTemplate
dcim.console_port_templates.id.delete
netboxdemo.dcim.console_port_templates.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console port template.
- id required
Output
Output schema unknown
dcim.console_port_templates.id.get
Call to super to allow for caching
netboxdemo.dcim.console_port_templates.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console port template.
- id required
Output
- output ConsolePortTemplate
dcim.console_port_templates.id.patch
netboxdemo.dcim.console_port_templates.id.patch({
"body": {
"device_type": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsolePortTemplate
- id required
integer: A unique integer value identifying this console port template.
Output
- output ConsolePortTemplate
dcim.console_port_templates.id.put
netboxdemo.dcim.console_port_templates.id.put({
"body": {
"device_type": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsolePortTemplate
- id required
integer: A unique integer value identifying this console port template.
Output
- output ConsolePortTemplate
dcim.console_ports.get
Call to super to allow for caching
netboxdemo.dcim.console_ports.get({}, context)Input
- input
object- id
string - name
string - description
string - connection_status
string - q
string - region_id
string - region
string - site_id
string - site
string - device_id
string - device
string - tag
string - type
string - cabled
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - description__n
string - description__ic
string - description__nic
string - description__iew
string - description__niew
string - description__isw
string - description__nisw
string - description__ie
string - description__nie
string - connection_status__n
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - device_id__n
string - device__n
string - tag__n
string - type__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items ConsolePort
- count required
dcim.console_ports.post
netboxdemo.dcim.console_ports.post({
"body": {
"device": 0,
"name": ""
}
}, context)Input
- input
object- body required WritableConsolePort
Output
- output ConsolePort
dcim.console_ports.id.delete
netboxdemo.dcim.console_ports.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console port.
- id required
Output
Output schema unknown
dcim.console_ports.id.get
Call to super to allow for caching
netboxdemo.dcim.console_ports.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console port.
- id required
Output
- output ConsolePort
dcim.console_ports.id.patch
netboxdemo.dcim.console_ports.id.patch({
"body": {
"device": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsolePort
- id required
integer: A unique integer value identifying this console port.
Output
- output ConsolePort
dcim.console_ports.id.put
netboxdemo.dcim.console_ports.id.put({
"body": {
"device": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsolePort
- id required
integer: A unique integer value identifying this console port.
Output
- output ConsolePort
dcim.console_ports.id.trace.get
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
netboxdemo.dcim.console_ports.id.trace.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console port.
- id required
Output
- output ConsolePort
dcim.console_server_port_templates.get
Call to super to allow for caching
netboxdemo.dcim.console_server_port_templates.get({}, context)Input
- input
object- id
string - name
string - type
string - q
string - devicetype_id
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - type__n
string - devicetype_id__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array
- count required
dcim.console_server_port_templates.post
netboxdemo.dcim.console_server_port_templates.post({
"body": {
"device_type": 0,
"name": ""
}
}, context)Input
- input
object- body required WritableConsoleServerPortTemplate
Output
- output ConsoleServerPortTemplate
dcim.console_server_port_templates.id.delete
netboxdemo.dcim.console_server_port_templates.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console server port template.
- id required
Output
Output schema unknown
dcim.console_server_port_templates.id.get
Call to super to allow for caching
netboxdemo.dcim.console_server_port_templates.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console server port template.
- id required
Output
- output ConsoleServerPortTemplate
dcim.console_server_port_templates.id.patch
netboxdemo.dcim.console_server_port_templates.id.patch({
"body": {
"device_type": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsoleServerPortTemplate
- id required
integer: A unique integer value identifying this console server port template.
Output
- output ConsoleServerPortTemplate
dcim.console_server_port_templates.id.put
netboxdemo.dcim.console_server_port_templates.id.put({
"body": {
"device_type": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsoleServerPortTemplate
- id required
integer: A unique integer value identifying this console server port template.
Output
- output ConsoleServerPortTemplate
dcim.console_server_ports.get
Call to super to allow for caching
netboxdemo.dcim.console_server_ports.get({}, context)Input
- input
object- id
string - name
string - description
string - connection_status
string - q
string - region_id
string - region
string - site_id
string - site
string - device_id
string - device
string - tag
string - type
string - cabled
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - description__n
string - description__ic
string - description__nic
string - description__iew
string - description__niew
string - description__isw
string - description__nisw
string - description__ie
string - description__nie
string - connection_status__n
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - device_id__n
string - device__n
string - tag__n
string - type__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items ConsoleServerPort
- count required
dcim.console_server_ports.post
netboxdemo.dcim.console_server_ports.post({
"body": {
"device": 0,
"name": ""
}
}, context)Input
- input
object- body required WritableConsoleServerPort
Output
- output ConsoleServerPort
dcim.console_server_ports.id.delete
netboxdemo.dcim.console_server_ports.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console server port.
- id required
Output
Output schema unknown
dcim.console_server_ports.id.get
Call to super to allow for caching
netboxdemo.dcim.console_server_ports.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console server port.
- id required
Output
- output ConsoleServerPort
dcim.console_server_ports.id.patch
netboxdemo.dcim.console_server_ports.id.patch({
"body": {
"device": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsoleServerPort
- id required
integer: A unique integer value identifying this console server port.
Output
- output ConsoleServerPort
dcim.console_server_ports.id.put
netboxdemo.dcim.console_server_ports.id.put({
"body": {
"device": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableConsoleServerPort
- id required
integer: A unique integer value identifying this console server port.
Output
- output ConsoleServerPort
dcim.console_server_ports.id.trace.get
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
netboxdemo.dcim.console_server_ports.id.trace.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this console server port.
- id required
Output
- output ConsoleServerPort
dcim.device_bay_templates.get
Call to super to allow for caching
netboxdemo.dcim.device_bay_templates.get({}, context)Input
- input
object- id
string - name
string - q
string - devicetype_id
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - devicetype_id__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items DeviceBayTemplate
- count required
dcim.device_bay_templates.post
netboxdemo.dcim.device_bay_templates.post({
"body": {
"device_type": 0,
"name": ""
}
}, context)Input
- input
object- body required WritableDeviceBayTemplate
Output
- output DeviceBayTemplate
dcim.device_bay_templates.id.delete
netboxdemo.dcim.device_bay_templates.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device bay template.
- id required
Output
Output schema unknown
dcim.device_bay_templates.id.get
Call to super to allow for caching
netboxdemo.dcim.device_bay_templates.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device bay template.
- id required
Output
- output DeviceBayTemplate
dcim.device_bay_templates.id.patch
netboxdemo.dcim.device_bay_templates.id.patch({
"body": {
"device_type": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceBayTemplate
- id required
integer: A unique integer value identifying this device bay template.
Output
- output DeviceBayTemplate
dcim.device_bay_templates.id.put
netboxdemo.dcim.device_bay_templates.id.put({
"body": {
"device_type": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceBayTemplate
- id required
integer: A unique integer value identifying this device bay template.
Output
- output DeviceBayTemplate
dcim.device_bays.get
Call to super to allow for caching
netboxdemo.dcim.device_bays.get({}, context)Input
- input
object- id
string - name
string - description
string - q
string - region_id
string - region
string - site_id
string - site
string - device_id
string - device
string - tag
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - description__n
string - description__ic
string - description__nic
string - description__iew
string - description__niew
string - description__isw
string - description__nisw
string - description__ie
string - description__nie
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - device_id__n
string - device__n
string - tag__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items DeviceBay
- count required
dcim.device_bays.post
netboxdemo.dcim.device_bays.post({
"body": {
"device": 0,
"name": ""
}
}, context)Input
- input
object- body required WritableDeviceBay
Output
- output DeviceBay
dcim.device_bays.id.delete
netboxdemo.dcim.device_bays.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device bay.
- id required
Output
Output schema unknown
dcim.device_bays.id.get
Call to super to allow for caching
netboxdemo.dcim.device_bays.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device bay.
- id required
Output
- output DeviceBay
dcim.device_bays.id.patch
netboxdemo.dcim.device_bays.id.patch({
"body": {
"device": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceBay
- id required
integer: A unique integer value identifying this device bay.
Output
- output DeviceBay
dcim.device_bays.id.put
netboxdemo.dcim.device_bays.id.put({
"body": {
"device": 0,
"name": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceBay
- id required
integer: A unique integer value identifying this device bay.
Output
- output DeviceBay
dcim.device_roles.get
Call to super to allow for caching
netboxdemo.dcim.device_roles.get({}, context)Input
- input
object- id
string - name
string - slug
string - color
string - vm_role
string - q
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - slug__n
string - slug__ic
string - slug__nic
string - slug__iew
string - slug__niew
string - slug__isw
string - slug__nisw
string - slug__ie
string - slug__nie
string - color__n
string - color__ic
string - color__nic
string - color__iew
string - color__niew
string - color__isw
string - color__nisw
string - color__ie
string - color__nie
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items DeviceRole
- count required
dcim.device_roles.post
netboxdemo.dcim.device_roles.post({
"body": {
"name": "",
"slug": ""
}
}, context)Input
- input
object- body required DeviceRole
Output
- output DeviceRole
dcim.device_roles.id.delete
netboxdemo.dcim.device_roles.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device role.
- id required
Output
Output schema unknown
dcim.device_roles.id.get
Call to super to allow for caching
netboxdemo.dcim.device_roles.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device role.
- id required
Output
- output DeviceRole
dcim.device_roles.id.patch
netboxdemo.dcim.device_roles.id.patch({
"body": {
"name": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required DeviceRole
- id required
integer: A unique integer value identifying this device role.
Output
- output DeviceRole
dcim.device_roles.id.put
netboxdemo.dcim.device_roles.id.put({
"body": {
"name": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required DeviceRole
- id required
integer: A unique integer value identifying this device role.
Output
- output DeviceRole
dcim.device_types.get
Call to super to allow for caching
netboxdemo.dcim.device_types.get({}, context)Input
- input
object- id
string - model
string - slug
string - part_number
string - u_height
string - is_full_depth
string - subdevice_role
string - created
string - created__gte
string - created__lte
string - last_updated
string - last_updated__gte
string - last_updated__lte
string - q
string - manufacturer_id
string - manufacturer
string - console_ports
string - console_server_ports
string - power_ports
string - power_outlets
string - interfaces
string - pass_through_ports
string - device_bays
string - tag
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - model__n
string - model__ic
string - model__nic
string - model__iew
string - model__niew
string - model__isw
string - model__nisw
string - model__ie
string - model__nie
string - slug__n
string - slug__ic
string - slug__nic
string - slug__iew
string - slug__niew
string - slug__isw
string - slug__nisw
string - slug__ie
string - slug__nie
string - part_number__n
string - part_number__ic
string - part_number__nic
string - part_number__iew
string - part_number__niew
string - part_number__isw
string - part_number__nisw
string - part_number__ie
string - part_number__nie
string - u_height__n
string - u_height__lte
string - u_height__lt
string - u_height__gte
string - u_height__gt
string - subdevice_role__n
string - manufacturer_id__n
string - manufacturer__n
string - tag__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items DeviceType
- count required
dcim.device_types.post
netboxdemo.dcim.device_types.post({
"body": {
"manufacturer": 0,
"model": "",
"slug": ""
}
}, context)Input
- input
object- body required WritableDeviceType
Output
- output DeviceType
dcim.device_types.id.delete
netboxdemo.dcim.device_types.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device type.
- id required
Output
Output schema unknown
dcim.device_types.id.get
Call to super to allow for caching
netboxdemo.dcim.device_types.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device type.
- id required
Output
- output DeviceType
dcim.device_types.id.patch
netboxdemo.dcim.device_types.id.patch({
"body": {
"manufacturer": 0,
"model": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceType
- id required
integer: A unique integer value identifying this device type.
Output
- output DeviceType
dcim.device_types.id.put
netboxdemo.dcim.device_types.id.put({
"body": {
"manufacturer": 0,
"model": "",
"slug": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceType
- id required
integer: A unique integer value identifying this device type.
Output
- output DeviceType
dcim_devices_list
Call to super to allow for caching
netboxdemo.dcim_devices_list({}, context)Input
- input
object- id
string - name
string - asset_tag
string - face
string - position
string - vc_position
string - vc_priority
string - tenant_group_id
string - tenant_group
string - tenant_id
string - tenant
string - local_context_data
string - created
string - created__gte
string - created__lte
string - last_updated
string - last_updated__gte
string - last_updated__lte
string - q
string - manufacturer_id
string - manufacturer
string - device_type_id
string - role_id
string - role
string - platform_id
string - platform
string - region_id
string - region
string - site_id
string - site
string - rack_group_id
string - rack_id
string - cluster_id
string - model
string - status
string - is_full_depth
string - mac_address
string - serial
string - has_primary_ip
string - virtual_chassis_id
string - virtual_chassis_member
string - console_ports
string - console_server_ports
string - power_ports
string - power_outlets
string - interfaces
string - pass_through_ports
string - device_bays
string - tag
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - asset_tag__n
string - asset_tag__ic
string - asset_tag__nic
string - asset_tag__iew
string - asset_tag__niew
string - asset_tag__isw
string - asset_tag__nisw
string - asset_tag__ie
string - asset_tag__nie
string - face__n
string - position__n
string - position__lte
string - position__lt
string - position__gte
string - position__gt
string - vc_position__n
string - vc_position__lte
string - vc_position__lt
string - vc_position__gte
string - vc_position__gt
string - vc_priority__n
string - vc_priority__lte
string - vc_priority__lt
string - vc_priority__gte
string - vc_priority__gt
string - tenant_group_id__n
string - tenant_group__n
string - tenant_id__n
string - tenant__n
string - manufacturer_id__n
string - manufacturer__n
string - device_type_id__n
string - role_id__n
string - role__n
string - platform_id__n
string - platform__n
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - rack_group_id__n
string - rack_id__n
string - cluster_id__n
string - model__n
string - status__n
string - mac_address__n
string - mac_address__ic
string - mac_address__nic
string - mac_address__iew
string - mac_address__niew
string - mac_address__isw
string - mac_address__nisw
string - mac_address__ie
string - mac_address__nie
string - virtual_chassis_id__n
string - tag__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items DeviceWithConfigContext
- count required
dcim_devices_create
netboxdemo.dcim_devices_create({
"body": {
"device_type": 0,
"device_role": 0,
"site": 0
}
}, context)Input
- input
object- body required WritableDeviceWithConfigContext
Output
- output DeviceWithConfigContext
dcim_devices_delete
netboxdemo.dcim_devices_delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device.
- id required
Output
Output schema unknown
dcim_devices_read
Call to super to allow for caching
netboxdemo.dcim_devices_read({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device.
- id required
Output
- output DeviceWithConfigContext
dcim_devices_partial_update
netboxdemo.dcim_devices_partial_update({
"body": {
"device_type": 0,
"device_role": 0,
"site": 0
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceWithConfigContext
- id required
integer: A unique integer value identifying this device.
Output
- output DeviceWithConfigContext
dcim_devices_update
netboxdemo.dcim_devices_update({
"body": {
"device_type": 0,
"device_role": 0,
"site": 0
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceWithConfigContext
- id required
integer: A unique integer value identifying this device.
Output
- output DeviceWithConfigContext
dcim_devices_graphs
A convenience method for rendering graphs for a particular Device.
netboxdemo.dcim_devices_graphs({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this device.
- id required
Output
- output DeviceWithConfigContext
dcim_devices_napalm
Execute a NAPALM method on a Device
netboxdemo.dcim_devices_napalm({
"method": "",
"id": 0
}, context)Input
- input
object- method required
string - id required
integer: A unique integer value identifying this device.
- method required
Output
- output DeviceNAPALM
dcim.front_port_templates.get
Call to super to allow for caching
netboxdemo.dcim.front_port_templates.get({}, context)Input
- input
object- id
string - name
string - type
string - q
string - devicetype_id
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - type__n
string - devicetype_id__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items FrontPortTemplate
- count required
dcim.front_port_templates.post
netboxdemo.dcim.front_port_templates.post({
"body": {
"device_type": 0,
"name": "",
"type": "",
"rear_port": 0
}
}, context)Input
- input
object- body required WritableFrontPortTemplate
Output
- output FrontPortTemplate
dcim.front_port_templates.id.delete
netboxdemo.dcim.front_port_templates.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this front port template.
- id required
Output
Output schema unknown
dcim.front_port_templates.id.get
Call to super to allow for caching
netboxdemo.dcim.front_port_templates.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this front port template.
- id required
Output
- output FrontPortTemplate
dcim.front_port_templates.id.patch
netboxdemo.dcim.front_port_templates.id.patch({
"body": {
"device_type": 0,
"name": "",
"type": "",
"rear_port": 0
},
"id": 0
}, context)Input
- input
object- body required WritableFrontPortTemplate
- id required
integer: A unique integer value identifying this front port template.
Output
- output FrontPortTemplate
dcim.front_port_templates.id.put
netboxdemo.dcim.front_port_templates.id.put({
"body": {
"device_type": 0,
"name": "",
"type": "",
"rear_port": 0
},
"id": 0
}, context)Input
- input
object- body required WritableFrontPortTemplate
- id required
integer: A unique integer value identifying this front port template.
Output
- output FrontPortTemplate
dcim.front_ports.get
Call to super to allow for caching
netboxdemo.dcim.front_ports.get({}, context)Input
- input
object- id
string - name
string - type
string - description
string - q
string - region_id
string - region
string - site_id
string - site
string - device_id
string - device
string - tag
string - cabled
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - type__n
string - description__n
string - description__ic
string - description__nic
string - description__iew
string - description__niew
string - description__isw
string - description__nisw
string - description__ie
string - description__nie
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - device_id__n
string - device__n
string - tag__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items FrontPort
- count required
dcim.front_ports.post
netboxdemo.dcim.front_ports.post({
"body": {
"device": 0,
"name": "",
"type": "",
"rear_port": 0
}
}, context)Input
- input
object- body required WritableFrontPort
Output
- output FrontPort
dcim.front_ports.id.delete
netboxdemo.dcim.front_ports.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this front port.
- id required
Output
Output schema unknown
dcim.front_ports.id.get
Call to super to allow for caching
netboxdemo.dcim.front_ports.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this front port.
- id required
Output
- output FrontPort
dcim.front_ports.id.patch
netboxdemo.dcim.front_ports.id.patch({
"body": {
"device": 0,
"name": "",
"type": "",
"rear_port": 0
},
"id": 0
}, context)Input
- input
object- body required WritableFrontPort
- id required
integer: A unique integer value identifying this front port.
Output
- output FrontPort
dcim.front_ports.id.put
netboxdemo.dcim.front_ports.id.put({
"body": {
"device": 0,
"name": "",
"type": "",
"rear_port": 0
},
"id": 0
}, context)Input
- input
object- body required WritableFrontPort
- id required
integer: A unique integer value identifying this front port.
Output
- output FrontPort
dcim.front_ports.id.trace.get
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
netboxdemo.dcim.front_ports.id.trace.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this front port.
- id required
Output
- output FrontPort
dcim.interface_connections.get
netboxdemo.dcim.interface_connections.get({}, context)Input
- input
object- connection_status
string - site
string - device_id
string - device
string - connection_status__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- connection_status
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items InterfaceConnection
- count required
dcim.interface_templates.get
Call to super to allow for caching
netboxdemo.dcim.interface_templates.get({}, context)Input
- input
object- id
string - name
string - type
string - mgmt_only
string - q
string - devicetype_id
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - type__n
string - devicetype_id__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items InterfaceTemplate
- count required
dcim.interface_templates.post
netboxdemo.dcim.interface_templates.post({
"body": {
"device_type": 0,
"name": "",
"type": ""
}
}, context)Input
- input
object- body required WritableInterfaceTemplate
Output
- output InterfaceTemplate
dcim.interface_templates.id.delete
netboxdemo.dcim.interface_templates.id.delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this interface template.
- id required
Output
Output schema unknown
dcim.interface_templates.id.get
Call to super to allow for caching
netboxdemo.dcim.interface_templates.id.get({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this interface template.
- id required
Output
- output InterfaceTemplate
dcim.interface_templates.id.patch
netboxdemo.dcim.interface_templates.id.patch({
"body": {
"device_type": 0,
"name": "",
"type": ""
},
"id": 0
}, context)Input
- input
object- body required WritableInterfaceTemplate
- id required
integer: A unique integer value identifying this interface template.
Output
- output InterfaceTemplate
dcim.interface_templates.id.put
netboxdemo.dcim.interface_templates.id.put({
"body": {
"device_type": 0,
"name": "",
"type": ""
},
"id": 0
}, context)Input
- input
object- body required WritableInterfaceTemplate
- id required
integer: A unique integer value identifying this interface template.
Output
- output InterfaceTemplate
dcim_interfaces_list
Call to super to allow for caching
netboxdemo.dcim_interfaces_list({}, context)Input
- input
object- id
string - name
string - connection_status
string - type
string - enabled
string - mtu
string - mgmt_only
string - mode
string - description
string - q
string - region_id
string - region
string - site_id
string - site
string - device_id
string - device
string - tag
string - cabled
string - kind
string - lag_id
string - mac_address
string - vlan_id
string - vlan
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - connection_status__n
string - type__n
string - mtu__n
string - mtu__lte
string - mtu__lt
string - mtu__gte
string - mtu__gt
string - mode__n
string - description__n
string - description__ic
string - description__nic
string - description__iew
string - description__niew
string - description__isw
string - description__nisw
string - description__ie
string - description__nie
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - tag__n
string - lag_id__n
string - mac_address__n
string - mac_address__ic
string - mac_address__nic
string - mac_address__iew
string - mac_address__niew
string - mac_address__isw
string - mac_address__nisw
string - mac_address__ie
string - mac_address__nie
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items DeviceInterface
- count required
dcim_interfaces_create
netboxdemo.dcim_interfaces_create({
"body": {
"device": 0,
"name": "",
"type": ""
}
}, context)Input
- input
object- body required WritableDeviceInterface
Output
- output DeviceInterface
dcim_interfaces_delete
netboxdemo.dcim_interfaces_delete({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this interface.
- id required
Output
Output schema unknown
dcim_interfaces_read
Call to super to allow for caching
netboxdemo.dcim_interfaces_read({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this interface.
- id required
Output
- output DeviceInterface
dcim_interfaces_partial_update
netboxdemo.dcim_interfaces_partial_update({
"body": {
"device": 0,
"name": "",
"type": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceInterface
- id required
integer: A unique integer value identifying this interface.
Output
- output DeviceInterface
dcim_interfaces_update
netboxdemo.dcim_interfaces_update({
"body": {
"device": 0,
"name": "",
"type": ""
},
"id": 0
}, context)Input
- input
object- body required WritableDeviceInterface
- id required
integer: A unique integer value identifying this interface.
Output
- output DeviceInterface
dcim_interfaces_graphs
A convenience method for rendering graphs for a particular interface.
netboxdemo.dcim_interfaces_graphs({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this interface.
- id required
Output
- output DeviceInterface
dcim_interfaces_trace
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
netboxdemo.dcim_interfaces_trace({
"id": 0
}, context)Input
- input
object- id required
integer: A unique integer value identifying this interface.
- id required
Output
- output DeviceInterface
dcim.inventory_items.get
Call to super to allow for caching
netboxdemo.dcim.inventory_items.get({}, context)Input
- input
object- id
string - name
string - part_id
string - asset_tag
string - discovered
string - q
string - region_id
string - region
string - site_id
string - site
string - device_id
string - device
string - tag
string - parent_id
string - manufacturer_id
string - manufacturer
string - serial
string - id__n
string - id__lte
string - id__lt
string - id__gte
string - id__gt
string - name__n
string - name__ic
string - name__nic
string - name__iew
string - name__niew
string - name__isw
string - name__nisw
string - name__ie
string - name__nie
string - part_id__n
string - part_id__ic
string - part_id__nic
string - part_id__iew
string - part_id__niew
string - part_id__isw
string - part_id__nisw
string - part_id__ie
string - part_id__nie
string - asset_tag__n
string - asset_tag__ic
string - asset_tag__nic
string - asset_tag__iew
string - asset_tag__niew
string - asset_tag__isw
string - asset_tag__nisw
string - asset_tag__ie
string - asset_tag__nie
string - region_id__n
string - region__n
string - site_id__n
string - site__n
string - device_id__n
string - device__n
string - tag__n
string - parent_id__n
string - manufacturer_id__n
string - manufacturer__n
string - limit
integer: Number of results to return per page. - offset
integer: The initial index from which to return the results.
- id
Output
- output
object- count required
integer - next
string - previous
string - results required
array- items InventoryItem
- count required
dc
3.0.0
5 years ago