NetBox
NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation.
2 APIs
0 Features
Data CenterDCIMInfrastructure as CodeIPAMNetwork AutomationNetwork ManagementOpen SourceSource of Truth
APIs
NetBox REST API
A comprehensive REST API for programmatic access to all NetBox data and functionality. Supports full CRUD operations for all objects including devices, IP addresses, circuits, a...
NetBox GraphQL API
A GraphQL API providing flexible querying capabilities for NetBox data with support for nested queries and custom field selection.
Collections
NetBox REST API
OPENGraphQL
NetBox GraphQL API
A GraphQL API providing flexible querying capabilities for NetBox data with support for nested queries and custom field selection.
GRAPHQLPricing Plans
Rate Limits
FinOps
Netbox Finops
FINOPSResources
🔗
LinkedIn
LinkedIn
👥
GitHubOrganization
GitHubOrganization
🔗
Slack Community
Slack Community
📰
Blog
Blog
🚀
GettingStarted
GettingStarted
🔗
Plugins
Plugins
🔗
Demo Instance
Demo Instance
Sources
opencollection: 1.0.0
info:
name: NetBox REST API
version: 4.5.9 (4.5)
items:
- info:
name: authentication-check
type: folder
items:
- info:
name: authentication_check_retrieve
type: http
http:
method: GET
url: /api/authentication-check/
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Return the user making the request, if authenticated successfully.
- info:
name: circuits
type: folder
items:
- info:
name: circuits_circuit_group_assignments_list
type: http
http:
method: GET
url: /api/circuits/circuit-group-assignments/
params:
- name: circuit
value: ''
type: query
- name: circuit_id
value: ''
type: query
- name: created
value: ''
type: query
- name: created__empty
value: ''
type: query
- name: created__gt
value: ''
type: query
- name: created__gte
value: ''
type: query
- name: created__lt
value: ''
type: query
- name: created__lte
value: ''
type: query
- name: created__n
value: ''
type: query
- name: created_by_request
value: ''
type: query
- name: group
value: ''
type: query
description: Circuit group (slug)
- name: group__n
value: ''
type: query
description: Circuit group (slug)
- name: group_id
value: ''
type: query
description: Circuit group (ID)
- name: group_id__n
value: ''
type: query
description: Circuit group (ID)
- name: id
value: ''
type: query
- name: id__empty
value: ''
type: query
- name: id__gt
value: ''
type: query
- name: id__gte
value: ''
type: query
- name: id__lt
value: ''
type: query
- name: id__lte
value: ''
type: query
- name: id__n
value: ''
type: query
- name: last_updated
value: ''
type: query
- name: last_updated__empty
value: ''
type: query
- name: last_updated__gt
value: ''
type: query
- name: last_updated__gte
value: ''
type: query
- name: last_updated__lt
value: ''
type: query
- name: last_updated__lte
value: ''
type: query
- name: last_updated__n
value: ''
type: query
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: member_id
value: ''
type: query
- name: member_id__empty
value: ''
type: query
- name: member_id__gt
value: ''
type: query
- name: member_id__gte
value: ''
type: query
- name: member_id__lt
value: ''
type: query
- name: member_id__lte
value: ''
type: query
- name: member_id__n
value: ''
type: query
- name: member_type
value: ''
type: query
- name: member_type__n
value: ''
type: query
- name: modified_by_request
value: ''
type: query
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
- name: ordering
value: ''
type: query
description: Which field to use when ordering the results.
- name: priority
value: ''
type: query
description: '* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive'
- name: priority__empty
value: ''
type: query
- name: priority__ic
value: ''
type: query
- name: priority__ie
value: ''
type: query
- name: priority__iew
value: ''
type: query
- name: priority__iregex
value: ''
type: query
- name: priority__isw
value: ''
type: query
- name: priority__n
value: ''
type: query
description: '* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive'
- name: priority__nic
value: ''
type: query
- name: priority__nie
value: ''
type: query
- name: priority__niew
value: ''
type: query
- name: priority__nisw
value: ''
type: query
- name: priority__regex
value: ''
type: query
- name: provider
value: ''
type: query
- name: provider_id
value: ''
type: query
- name: q
value: ''
type: query
description: Search
- name: tag
value: ''
type: query
- name: tag__n
value: ''
type: query
- name: tag_id
value: ''
type: query
- name: tag_id__n
value: ''
type: query
- name: updated_by_request
value: ''
type: query
- name: virtual_circuit
value: ''
type: query
- name: virtual_circuit_id
value: ''
type: query
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Get a list of Circuit group assignment objects.
- info:
name: circuits_circuit_group_assignments_create
type: http
http:
method: POST
url: /api/circuits/circuit-group-assignments/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Post a list of Circuit group assignment objects.
- info:
name: circuits_circuit_group_assignments_bulk_update
type: http
http:
method: PUT
url: /api/circuits/circuit-group-assignments/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Put a list of Circuit group assignment objects.
- info:
name: circuits_circuit_group_assignments_bulk_partial_update
type: http
http:
method: PATCH
url: /api/circuits/circuit-group-assignments/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Patch a list of Circuit group assignment objects.
- info:
name: circuits_circuit_group_assignments_bulk_destroy
type: http
http:
method: DELETE
url: /api/circuits/circuit-group-assignments/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Delete a list of Circuit group assignment objects.
- info:
name: circuits_circuit_group_assignments_retrieve
type: http
http:
method: GET
url: /api/circuits/circuit-group-assignments/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this Circuit group assignment.
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Get a Circuit group assignment object.
- info:
name: circuits_circuit_group_assignments_update
type: http
http:
method: PUT
url: /api/circuits/circuit-group-assignments/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this Circuit group assignment.
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Put a Circuit group assignment object.
- info:
name: circuits_circuit_group_assignments_partial_update
type: http
http:
method: PATCH
url: /api/circuits/circuit-group-assignments/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this Circuit group assignment.
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Patch a Circuit group assignment object.
- info:
name: circuits_circuit_group_assignments_destroy
type: http
http:
method: DELETE
url: /api/circuits/circuit-group-assignments/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this Circuit group assignment.
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Delete a Circuit group assignment object.
- info:
name: circuits_circuit_groups_list
type: http
http:
method: GET
url: /api/circuits/circuit-groups/
params:
- name: created
value: ''
type: query
- name: created__empty
value: ''
type: query
- name: created__gt
value: ''
type: query
- name: created__gte
value: ''
type: query
- name: created__lt
value: ''
type: query
- name: created__lte
value: ''
type: query
- name: created__n
value: ''
type: query
- name: created_by_request
value: ''
type: query
- name: description
value: ''
type: query
- name: description__empty
value: ''
type: query
- name: description__ic
value: ''
type: query
- name: description__ie
value: ''
type: query
- name: description__iew
value: ''
type: query
- name: description__iregex
value: ''
type: query
- name: description__isw
value: ''
type: query
- name: description__n
value: ''
type: query
- name: description__nic
value: ''
type: query
- name: description__nie
value: ''
type: query
- name: description__niew
value: ''
type: query
- name: description__nisw
value: ''
type: query
- name: description__regex
value: ''
type: query
- name: id
value: ''
type: query
- name: id__empty
value: ''
type: query
- name: id__gt
value: ''
type: query
- name: id__gte
value: ''
type: query
- name: id__lt
value: ''
type: query
- name: id__lte
value: ''
type: query
- name: id__n
value: ''
type: query
- name: last_updated
value: ''
type: query
- name: last_updated__empty
value: ''
type: query
- name: last_updated__gt
value: ''
type: query
- name: last_updated__gte
value: ''
type: query
- name: last_updated__lt
value: ''
type: query
- name: last_updated__lte
value: ''
type: query
- name: last_updated__n
value: ''
type: query
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: modified_by_request
value: ''
type: query
- name: name
value: ''
type: query
- name: name__empty
value: ''
type: query
- name: name__ic
value: ''
type: query
- name: name__ie
value: ''
type: query
- name: name__iew
value: ''
type: query
- name: name__iregex
value: ''
type: query
- name: name__isw
value: ''
type: query
- name: name__n
value: ''
type: query
- name: name__nic
value: ''
type: query
- name: name__nie
value: ''
type: query
- name: name__niew
value: ''
type: query
- name: name__nisw
value: ''
type: query
- name: name__regex
value: ''
type: query
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
- name: ordering
value: ''
type: query
description: Which field to use when ordering the results.
- name: owner
value: ''
type: query
description: Owner (name)
- name: owner__n
value: ''
type: query
description: Owner (name)
- name: owner_group
value: ''
type: query
description: Owner Group (name)
- name: owner_group__n
value: ''
type: query
description: Owner Group (name)
- name: owner_group_id
value: ''
type: query
description: Owner Group (ID)
- name: owner_group_id__n
value: ''
type: query
description: Owner Group (ID)
- name: owner_id
value: ''
type: query
description: Owner (ID)
- name: owner_id__n
value: ''
type: query
description: Owner (ID)
- name: q
value: ''
type: query
description: Search
- name: slug
value: ''
type: query
- name: slug__empty
value: ''
type: query
- name: slug__ic
value: ''
type: query
- name: slug__ie
value: ''
type: query
- name: slug__iew
value: ''
type: query
- name: slug__iregex
value: ''
type: query
- name: slug__isw
value: ''
type: query
- name: slug__n
value: ''
type: query
- name: slug__nic
value: ''
type: query
- name: slug__nie
value: ''
type: query
- name: slug__niew
value: ''
type: query
- name: slug__nisw
value: ''
type: query
- name: slug__regex
value: ''
type: query
- name: tag
value: ''
type: query
- name: tag__n
value: ''
type: query
- name: tag_id
value: ''
type: query
- name: tag_id__n
value: ''
type: query
- name: tenant
value: ''
type: query
description: Tenant (slug)
- name: tenant__n
value: ''
type: query
description: Tenant (slug)
- name: tenant_group
value: ''
type: query
- name: tenant_group__n
value: ''
type: query
- name: tenant_group_id
value: ''
type: query
- name: tenant_group_id__n
value: ''
type: query
- name: tenant_id
value: ''
type: query
description: Tenant (ID)
- name: tenant_id__n
value: ''
type: query
description: Tenant (ID)
- name: updated_by_request
value: ''
type: query
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Get a list of circuit group objects.
- info:
name: circuits_circuit_groups_create
type: http
http:
method: POST
url: /api/circuits/circuit-groups/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Post a list of circuit group objects.
- info:
name: circuits_circuit_groups_bulk_update
type: http
http:
method: PUT
url: /api/circuits/circuit-groups/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Put a list of circuit group objects.
- info:
name: circuits_circuit_groups_bulk_partial_update
type: http
http:
method: PATCH
url: /api/circuits/circuit-groups/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Patch a list of circuit group objects.
- info:
name: circuits_circuit_groups_bulk_destroy
type: http
http:
method: DELETE
url: /api/circuits/circuit-groups/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Delete a list of circuit group objects.
- info:
name: circuits_circuit_groups_retrieve
type: http
http:
method: GET
url: /api/circuits/circuit-groups/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this circuit group.
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Get a circuit group object.
- info:
name: circuits_circuit_groups_update
type: http
http:
method: PUT
url: /api/circuits/circuit-groups/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this circuit group.
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Put a circuit group object.
- info:
name: circuits_circuit_groups_partial_update
type: http
http:
method: PATCH
url: /api/circuits/circuit-groups/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this circuit group.
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Patch a circuit group object.
- info:
name: circuits_circuit_groups_destroy
type: http
http:
method: DELETE
url: /api/circuits/circuit-groups/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this circuit group.
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Delete a circuit group object.
- info:
name: circuits_circuit_terminations_list
type: http
http:
method: GET
url: /api/circuits/circuit-terminations/
params:
- name: cable_connector
value: ''
type: query
- name: cable_connector__empty
value: ''
type: query
- name: cable_connector__gt
value: ''
type: query
- name: cable_connector__gte
value: ''
type: query
- name: cable_connector__lt
value: ''
type: query
- name: cable_connector__lte
value: ''
type: query
- name: cable_connector__n
value: ''
type: query
- name: cable_end
value: ''
type: query
description: '* `A` - A
* `B` - B'
- name: cable_end__empty
value: ''
type: query
- name: cable_end__ic
value: ''
type: query
- name: cable_end__ie
value: ''
type: query
- name: cable_end__iew
value: ''
type: query
- name: cable_end__iregex
value: ''
type: query
- name: cable_end__isw
value: ''
type: query
- name: cable_end__n
value: ''
type: query
description: '* `A` - A
* `B` - B'
- name: cable_end__nic
value: ''
type: query
- name: cable_end__nie
value: ''
type: query
- name: cable_end__niew
value: ''
type: query
- name: cable_end__nisw
value: ''
type: query
- name: cable_end__regex
value: ''
type: query
- name: cable_id
value: ''
type: query
description: Cable (ID)
- name: cable_id__n
value: ''
type: query
description: Cable (ID)
- name: cabled
value: ''
type: query
- name: circuit_id
value: ''
type: query
description: Circuit
- name: circuit_id__n
value: ''
type: query
description: Circuit
- name: created
value: ''
type: query
- name: created__empty
value: ''
type: query
- name: created__gt
value: ''
type: query
- name: created__gte
value: ''
type: query
- name: created__lt
value: ''
type: query
- name: created__lte
value: ''
type: query
- name: created__n
value: ''
type: query
- name: created_by_request
value: ''
type: query
- name: description
value: ''
type: query
- name: description__empty
value: ''
type: query
- name: description__ic
value: ''
type: query
- name: description__ie
value: ''
type: query
- name: description__iew
value: ''
type: query
- name: description__iregex
value: ''
type: query
- name: description__isw
value: ''
type: query
- name: description__n
value: ''
type: query
- name: description__nic
value: ''
type: query
- name: description__nie
value: ''
type: query
- name: description__niew
value: ''
type: query
- name: description__nisw
value: ''
type: query
- name: description__regex
value: ''
type: query
- name: id
value: ''
type: query
- name: id__empty
value: ''
type: query
- name: id__gt
value: ''
type: query
- name: id__gte
value: ''
type: query
- name: id__lt
value: ''
type: query
- name: id__lte
value: ''
type: query
- name: id__n
value: ''
type: query
- name: last_updated
value: ''
type: query
- name: last_updated__empty
value: ''
type: query
- name: last_updated__gt
value: ''
type: query
- name: last_updated__gte
value: ''
type: query
- name: last_updated__lt
value: ''
type: query
- name: last_updated__lte
value: ''
type: query
- name: last_updated__n
value: ''
type: query
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: location
value: ''
type: query
- name: location__n
value: ''
type: query
- name: location_id
value: ''
type: query
- name: location_id__n
value: ''
type: query
- name: mark_connected
value: ''
type: query
- name: modified_by_request
value: ''
type: query
- name: occupied
value: ''
type: query
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
- name: ordering
value: ''
type: query
description: Which field to use when ordering the results.
- name: port_speed
value: ''
type: query
- name: port_speed__empty
value: ''
type: query
- name: port_speed__gt
value: ''
type: query
- name: port_speed__gte
value: ''
type: query
- name: port_speed__lt
value: ''
type: query
- name: port_speed__lte
value: ''
type: query
- name: port_speed__n
value: ''
type: query
- name: pp_info
value: ''
type: query
- name: pp_info__empty
value: ''
type: query
- name: pp_info__ic
value: ''
type: query
- name: pp_info__ie
value: ''
type: query
- name: pp_info__iew
value: ''
type: query
- name: pp_info__iregex
value: ''
type: query
- name: pp_info__isw
value: ''
type: query
- name: pp_info__n
value: ''
type: query
- name: pp_info__nic
value: ''
type: query
- name: pp_info__nie
value: ''
type: query
- name: pp_info__niew
value: ''
type: query
- name: pp_info__nisw
value: ''
type: query
- name: pp_info__regex
value: ''
type: query
- name: provider
value: ''
type: query
description: Provider (slug)
- name: provider__n
value: ''
type: query
description: Provider (slug)
- name: provider_id
value: ''
type: query
description: Provider (ID)
- name: provider_id__n
value: ''
type: query
description: Provider (ID)
- name: provider_network_id
value: ''
type: query
description: ProviderNetwork (ID)
- name: provider_network_id__n
value: ''
type: query
description: ProviderNetwork (ID)
- name: q
value: ''
type: query
description: Search
- name: region
value: ''
type: query
- name: region__n
value: ''
type: query
- name: region_id
value: ''
type: query
- name: region_id__n
value: ''
type: query
- name: site
value: ''
type: query
description: Site (slug)
- name: site__n
value: ''
type: query
description: Site (slug)
- name: site_group
value: ''
type: query
- name: site_group__n
value: ''
type: query
- name: site_group_id
value: ''
type: query
- name: site_group_id__n
value: ''
type: query
- name: site_id
value: ''
type: query
description: Site (ID)
- name: site_id__n
value: ''
type: query
description: Site (ID)
- name: tag
value: ''
type: query
- name: tag__n
value: ''
type: query
- name: tag_id
value: ''
type: query
- name: tag_id__n
value: ''
type: query
- name: term_side
value: ''
type: query
description: '* `A` - A
* `Z` - Z'
- name: term_side__empty
value: ''
type: query
- name: term_side__ic
value: ''
type: query
- name: term_side__ie
value: ''
type: query
- name: term_side__iew
value: ''
type: query
- name: term_side__iregex
value: ''
type: query
- name: term_side__isw
value: ''
type: query
- name: term_side__n
value: ''
type: query
description: '* `A` - A
* `Z` - Z'
- name: term_side__nic
value: ''
type: query
- name: term_side__nie
value: ''
type: query
- name: term_side__niew
value: ''
type: query
- name: term_side__nisw
value: ''
type: query
- name: term_side__regex
value: ''
type: query
- name: termination_id
value: ''
type: query
- name: termination_id__empty
value: ''
type: query
- name: termination_id__gt
value: ''
type: query
- name: termination_id__gte
value: ''
type: query
- name: termination_id__lt
value: ''
type: query
- name: termination_id__lte
value: ''
type: query
- name: termination_id__n
value: ''
type: query
- name: termination_type
value: ''
type: query
- name: termination_type__n
value: ''
type: query
- name: updated_by_request
value: ''
type: query
- name: upstream_speed
value: ''
type: query
- name: upstream_speed__empty
value: ''
type: query
- name: upstream_speed__gt
value: ''
type: query
- name: upstream_speed__gte
value: ''
type: query
- name: upstream_speed__lt
value: ''
type: query
- name: upstream_speed__lte
value: ''
type: query
- name: upstream_speed__n
value: ''
type: query
- name: xconnect_id
value: ''
type: query
- name: xconnect_id__empty
value: ''
type: query
- name: xconnect_id__ic
value: ''
type: query
- name: xconnect_id__ie
value: ''
type: query
- name: xconnect_id__iew
value: ''
type: query
- name: xconnect_id__iregex
value: ''
type: query
- name: xconnect_id__isw
value: ''
type: query
- name: xconnect_id__n
value: ''
type: query
- name: xconnect_id__nic
value: ''
type: query
- name: xconnect_id__nie
value: ''
type: query
- name: xconnect_id__niew
value: ''
type: query
- name: xconnect_id__nisw
value: ''
type: query
- name: xconnect_id__regex
value: ''
type: query
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Get a list of circuit termination objects.
- info:
name: circuits_circuit_terminations_create
type: http
http:
method: POST
url: /api/circuits/circuit-terminations/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Post a list of circuit termination objects.
- info:
name: circuits_circuit_terminations_bulk_update
type: http
http:
method: PUT
url: /api/circuits/circuit-terminations/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Put a list of circuit termination objects.
- info:
name: circuits_circuit_terminations_bulk_partial_update
type: http
http:
method: PATCH
url: /api/circuits/circuit-terminations/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Patch a list of circuit termination objects.
- info:
name: circuits_circuit_terminations_bulk_destroy
type: http
http:
method: DELETE
url: /api/circuits/circuit-terminations/
body:
type: json
data: '{}'
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Delete a list of circuit termination objects.
- info:
name: circuits_circuit_terminations_retrieve
type: http
http:
method: GET
url: /api/circuits/circuit-terminations/:id/
params:
- name: id
value: ''
type: path
description: A unique integer value identifying this circuit termination.
auth:
type: apikey
key: sessionid
value: '{{sessionid}}'
placement: query
docs: Get a circuit termination object.
- info:
name: circuits_circuit_terminations_update
type: http
http:
# --- truncated at 32 KB (1492 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/apis.yml