@itentialopensource/adapter-netbox_v210
Version:
This adapter integrates with system described as: Netbox v2.10
45,844 lines • 1.1 MB
YAML
openapi: 3.0.0
info:
title: NetBox API
description: API to access NetBox
contact: {}
version: '2.10'
servers:
- url: https://netbox.core-services.test.leaseplan.systems/api
variables: {}
paths:
/circuits/circuit-terminations/:
get:
tags:
- circuits
summary: circuits_circuit-terminations_list
description: ''
operationId: circuits_circuit-terminations_list
parameters:
- name: term_side
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port_speed
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: upstream_speed
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: circuit_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: term_side__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port_speed__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port_speed__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port_speed__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port_speed__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port_speed__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: upstream_speed__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: upstream_speed__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: upstream_speed__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: upstream_speed__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: upstream_speed__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: xconnect_id__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: circuit_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/circuits_circuit-terminations_listResponse'
deprecated: false
post:
tags:
- circuits
summary: circuits_circuit-terminations_create
description: ''
operationId: circuits_circuit-terminations_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuitTermination'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
put:
tags:
- circuits
summary: circuits_circuit-terminations_bulk_update
description: ''
operationId: circuits_circuit-terminations_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuitTermination'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
patch:
tags:
- circuits
summary: circuits_circuit-terminations_bulk_partial_update
description: ''
operationId: circuits_circuit-terminations_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuitTermination'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
delete:
tags:
- circuits
summary: circuits_circuit-terminations_bulk_delete
description: ''
operationId: circuits_circuit-terminations_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/circuit-terminations/{id}/:
get:
tags:
- circuits
summary: circuits_circuit-terminations_read
description: ''
operationId: circuits_circuit-terminations_read
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
put:
tags:
- circuits
summary: circuits_circuit-terminations_update
description: ''
operationId: circuits_circuit-terminations_update
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuitTermination'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
patch:
tags:
- circuits
summary: circuits_circuit-terminations_partial_update
description: ''
operationId: circuits_circuit-terminations_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuitTermination'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
delete:
tags:
- circuits
summary: circuits_circuit-terminations_delete
description: ''
operationId: circuits_circuit-terminations_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/circuit-terminations/{id}/trace/:
get:
tags:
- circuits
summary: circuits_circuit-terminations_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: circuits_circuit-terminations_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitTermination'
deprecated: false
/circuits/circuit-types/:
get:
tags:
- circuits
summary: circuits_circuit-types_list
description: ''
operationId: circuits_circuit-types_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/circuits_circuit-types_listResponse'
deprecated: false
post:
tags:
- circuits
summary: circuits_circuit-types_create
description: ''
operationId: circuits_circuit-types_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
deprecated: false
put:
tags:
- circuits
summary: circuits_circuit-types_bulk_update
description: ''
operationId: circuits_circuit-types_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
deprecated: false
patch:
tags:
- circuits
summary: circuits_circuit-types_bulk_partial_update
description: ''
operationId: circuits_circuit-types_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
deprecated: false
delete:
tags:
- circuits
summary: circuits_circuit-types_bulk_delete
description: ''
operationId: circuits_circuit-types_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/circuit-types/{id}/:
get:
tags:
- circuits
summary: circuits_circuit-types_read
description: ''
operationId: circuits_circuit-types_read
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
deprecated: false
put:
tags:
- circuits
summary: circuits_circuit-types_update
description: ''
operationId: circuits_circuit-types_update
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit type.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
deprecated: false
patch:
tags:
- circuits
summary: circuits_circuit-types_partial_update
description: ''
operationId: circuits_circuit-types_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit type.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CircuitType'
deprecated: false
delete:
tags:
- circuits
summary: circuits_circuit-types_delete
description: ''
operationId: circuits_circuit-types_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/circuits/:
get:
tags:
- circuits
summary: circuits_circuits_list
description: ''
operationId: circuits_circuits_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: install_date
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: commit_rate
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: provider_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: provider
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cid__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: install_date__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: install_date__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: install_date__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: install_date__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: install_date__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: commit_rate__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: commit_rate__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: commit_rate__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: commit_rate__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: commit_rate__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: provider_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: provider__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/circuits_circuits_listResponse'
deprecated: false
post:
tags:
- circuits
summary: circuits_circuits_create
description: ''
operationId: circuits_circuits_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuit'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Circuit'
deprecated: false
put:
tags:
- circuits
summary: circuits_circuits_bulk_update
description: ''
operationId: circuits_circuits_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuit'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Circuit'
deprecated: false
patch:
tags:
- circuits
summary: circuits_circuits_bulk_partial_update
description: ''
operationId: circuits_circuits_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuit'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Circuit'
deprecated: false
delete:
tags:
- circuits
summary: circuits_circuits_bulk_delete
description: ''
operationId: circuits_circuits_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/circuits/{id}/:
get:
tags:
- circuits
summary: circuits_circuits_read
description: ''
operationId: circuits_circuits_read
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Circuit'
deprecated: false
put:
tags:
- circuits
summary: circuits_circuits_update
description: ''
operationId: circuits_circuits_update
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuit'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Circuit'
deprecated: false
patch:
tags:
- circuits
summary: circuits_circuits_partial_update
description: ''
operationId: circuits_circuits_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCircuit'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Circuit'
deprecated: false
delete:
tags:
- circuits
summary: circuits_circuits_delete
description: ''
operationId: circuits_circuits_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/providers/:
get:
tags:
- circuits
summary: circuits_providers_list
description: ''
operationId: circuits_providers_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: account__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/circuits_providers_listResponse'
deprecated: false
post:
tags:
- circuits
summary: circuits_providers_create
description: ''
operationId: circuits_providers_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
deprecated: false
put:
tags:
- circuits
summary: circuits_providers_bulk_update
description: ''
operationId: circuits_providers_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
deprecated: false
patch:
tags:
- circuits
summary: circuits_providers_bulk_partial_update
description: ''
operationId: circuits_providers_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
deprecated: false
delete:
tags:
- circuits
summary: circuits_providers_bulk_delete
description: ''
operationId: circuits_providers_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/circuits/providers/{id}/:
get:
tags:
- circuits
summary: circuits_providers_read
description: ''
operationId: circuits_providers_read
parameters:
- name: id
in: path
description: A unique integer value identifying this provider.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
deprecated: false
put:
tags:
- circuits
summary: circuits_providers_update
description: ''
operationId: circuits_providers_update
parameters:
- name: id
in: path
description: A unique integer value identifying this provider.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
deprecated: false
patch:
tags:
- circuits
summary: circuits_providers_partial_update
description: ''
operationId: circuits_providers_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this provider.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
deprecated: false
delete:
tags:
- circuits
summary: circuits_providers_delete
description: ''
operationId: circuits_providers_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this provider.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/cables/:
get:
tags:
- dcim
summary: dcim_cables_list
description: ''
operationId: dcim_cables_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length_unit
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: label__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: length_unit__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_cables_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_cables_create
description: ''
operationId: dcim_cables_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCable'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cable'
deprecated: false
put:
tags:
- dcim
summary: dcim_cables_bulk_update
description: ''
operationId: dcim_cables_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCable'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cable'
deprecated: false
patch:
tags:
- dcim
summary: dcim_cables_bulk_partial_update
description: ''
operationId: dcim_cables_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCable'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cable'
deprecated: false
delete:
tags:
- dcim
summary: dcim_cables_bulk_delete
description: ''
operationId: dcim_cables_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/cables/{id}/:
get:
tags:
- dcim
summary: dcim_cables_read
description: ''
operationId: dcim_cables_read
parameters:
- name: id
in: path
description: A unique integer value identifying this cable.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cable'
deprecated: false
put:
tags:
- dcim
summary: dcim_cables_update
description: ''
operationId: dcim_cables_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cable.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCable'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cable'
deprecated: false
patch:
tags:
- dcim
summary: dcim_cables_partial_update
description: ''
operationId: dcim_cables_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cable.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCable'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cable'
deprecated: false
delete:
tags:
- dcim
summary: dcim_cables_delete
description: ''
operationId: dcim_cables_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this cable.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/connected-device/:
get:
tags:
- dcim
summary: dcim_connected-device_list
description: >-
This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer
interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors
via a protocol such as LLDP. Two query parameters must be included in the request:
* `peer_device`: The name of the peer device
* `peer_interface`: The name of the peer interface
operationId: dcim_connected-device_list
parameters:
- name: peer_device
in: query
description: The name of the peer device
required: true
style: form
explode: true
schema:
type: string
- name: peer_interface
in: query
description: The name of the peer interface
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Device'
deprecated: false
/dcim/console-connections/:
get:
tags:
- dcim
summary: dcim_console-connections_list
description: ''
operationId: dcim_console-connections_list
parameters:
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_console-connections_listResponse'
deprecated: false
/dcim/console-port-templates/:
get:
tags:
- dcim
summary: dcim_console-port-templates_list
description: ''
operationId: dcim_console-port-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_console-port-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_console-port-templates_create
description: ''
operationId: dcim_console-port-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePortTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-port-templates_bulk_update
description: ''
operationId: dcim_console-port-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-port-templates_bulk_partial_update
description: ''
operationId: dcim_console-port-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-port-templates_bulk_delete
description: ''
operationId: dcim_console-port-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-port-templates/{id}/:
get:
tags:
- dcim
summary: dcim_console-port-templates_read
description: ''
operationId: dcim_console-port-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this console port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-port-templates_update
description: ''
operationId: dcim_console-port-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-port-templates_partial_update
description: ''
operationId: dcim_console-port-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-port-templates_delete
description: ''
operationId: dcim_console-port-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this console port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-ports/:
get:
tags:
- dcim
summary: dcim_console-ports_list
description: ''
operationId: dcim_console-ports_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_console-ports_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_console-ports_create
description: ''
operationId: dcim_console-ports_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePort'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-ports_bulk_update
description: ''
operationId: dcim_console-ports_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-ports_bulk_partial_update
description: ''
operationId: dcim_console-ports_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-ports_bulk_delete
description: ''
operationId: dcim_console-ports_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-ports/{id}/:
get:
tags:
- dcim
summary: dcim_console-ports_read
description: ''
operationId: dcim_console-ports_read
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-ports_update
description: ''
operationId: dcim_console-ports_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-ports_partial_update
description: ''
operationId: dcim_console-ports_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsolePort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-ports_delete
description: ''
operationId: dcim_console-ports_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-ports/{id}/trace/:
get:
tags:
- dcim
summary: dcim_console-ports_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: dcim_console-ports_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsolePort'
deprecated: false
/dcim/console-server-port-templates/:
get:
tags:
- dcim
summary: dcim_console-server-port-templates_list
description: ''
operationId: dcim_console-server-port-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_console-server-port-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_console-server-port-templates_create
description: ''
operationId: dcim_console-server-port-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-server-port-templates_bulk_update
description: ''
operationId: dcim_console-server-port-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-server-port-templates_bulk_partial_update
description: ''
operationId: dcim_console-server-port-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-server-port-templates_bulk_delete
description: ''
operationId: dcim_console-server-port-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-server-port-templates/{id}/:
get:
tags:
- dcim
summary: dcim_console-server-port-templates_read
description: ''
operationId: dcim_console-server-port-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-server-port-templates_update
description: ''
operationId: dcim_console-server-port-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-server-port-templates_partial_update
description: ''
operationId: dcim_console-server-port-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-server-port-templates_delete
description: ''
operationId: dcim_console-server-port-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-server-ports/:
get:
tags:
- dcim
summary: dcim_console-server-ports_list
description: ''
operationId: dcim_console-server-ports_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_console-server-ports_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_console-server-ports_create
description: ''
operationId: dcim_console-server-ports_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPort'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-server-ports_bulk_update
description: ''
operationId: dcim_console-server-ports_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-server-ports_bulk_partial_update
description: ''
operationId: dcim_console-server-ports_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-server-ports_bulk_delete
description: ''
operationId: dcim_console-server-ports_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-server-ports/{id}/:
get:
tags:
- dcim
summary: dcim_console-server-ports_read
description: ''
operationId: dcim_console-server-ports_read
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_console-server-ports_update
description: ''
operationId: dcim_console-server-ports_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_console-server-ports_partial_update
description: ''
operationId: dcim_console-server-ports_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConsoleServerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_console-server-ports_delete
description: ''
operationId: dcim_console-server-ports_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/console-server-ports/{id}/trace/:
get:
tags:
- dcim
summary: dcim_console-server-ports_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: dcim_console-server-ports_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleServerPort'
deprecated: false
/dcim/device-bay-templates/:
get:
tags:
- dcim
summary: dcim_device-bay-templates_list
description: ''
operationId: dcim_device-bay-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_device-bay-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_device-bay-templates_create
description: ''
operationId: dcim_device-bay-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBayTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBayTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-bay-templates_bulk_update
description: ''
operationId: dcim_device-bay-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBayTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBayTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-bay-templates_bulk_partial_update
description: ''
operationId: dcim_device-bay-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBayTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBayTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-bay-templates_bulk_delete
description: ''
operationId: dcim_device-bay-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-bay-templates/{id}/:
get:
tags:
- dcim
summary: dcim_device-bay-templates_read
description: ''
operationId: dcim_device-bay-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBayTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-bay-templates_update
description: ''
operationId: dcim_device-bay-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBayTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBayTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-bay-templates_partial_update
description: ''
operationId: dcim_device-bay-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBayTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBayTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-bay-templates_delete
description: ''
operationId: dcim_device-bay-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-bays/:
get:
tags:
- dcim
summary: dcim_device-bays_list
description: ''
operationId: dcim_device-bays_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_device-bays_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_device-bays_create
description: ''
operationId: dcim_device-bays_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBay'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBay'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-bays_bulk_update
description: ''
operationId: dcim_device-bays_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBay'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBay'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-bays_bulk_partial_update
description: ''
operationId: dcim_device-bays_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBay'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBay'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-bays_bulk_delete
description: ''
operationId: dcim_device-bays_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-bays/{id}/:
get:
tags:
- dcim
summary: dcim_device-bays_read
description: ''
operationId: dcim_device-bays_read
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBay'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-bays_update
description: ''
operationId: dcim_device-bays_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBay'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBay'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-bays_partial_update
description: ''
operationId: dcim_device-bays_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceBay'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceBay'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-bays_delete
description: ''
operationId: dcim_device-bays_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-roles/:
get:
tags:
- dcim
summary: dcim_device-roles_list
description: ''
operationId: dcim_device-roles_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vm_role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_device-roles_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_device-roles_create
description: ''
operationId: dcim_device-roles_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-roles_bulk_update
description: ''
operationId: dcim_device-roles_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-roles_bulk_partial_update
description: ''
operationId: dcim_device-roles_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-roles_bulk_delete
description: ''
operationId: dcim_device-roles_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-roles/{id}/:
get:
tags:
- dcim
summary: dcim_device-roles_read
description: ''
operationId: dcim_device-roles_read
parameters:
- name: id
in: path
description: A unique integer value identifying this device role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-roles_update
description: ''
operationId: dcim_device-roles_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-roles_partial_update
description: ''
operationId: dcim_device-roles_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRole'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-roles_delete
description: ''
operationId: dcim_device-roles_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this device role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-types/:
get:
tags:
- dcim
summary: dcim_device-types_list
description: ''
operationId: dcim_device-types_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_full_depth
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: subdevice_role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: console_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: console_server_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: power_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: power_outlets
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: interfaces
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: pass_through_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_bays
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_number__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: subdevice_role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_device-types_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_device-types_create
description: ''
operationId: dcim_device-types_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceType'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceType'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-types_bulk_update
description: ''
operationId: dcim_device-types_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceType'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-types_bulk_partial_update
description: ''
operationId: dcim_device-types_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceType'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-types_bulk_delete
description: ''
operationId: dcim_device-types_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/device-types/{id}/:
get:
tags:
- dcim
summary: dcim_device-types_read
description: ''
operationId: dcim_device-types_read
parameters:
- name: id
in: path
description: A unique integer value identifying this device type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceType'
deprecated: false
put:
tags:
- dcim
summary: dcim_device-types_update
description: ''
operationId: dcim_device-types_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device type.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceType'
deprecated: false
patch:
tags:
- dcim
summary: dcim_device-types_partial_update
description: ''
operationId: dcim_device-types_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device type.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceType'
deprecated: false
delete:
tags:
- dcim
summary: dcim_device-types_delete
description: ''
operationId: dcim_device-types_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this device type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/devices/:
get:
tags:
- dcim
summary: dcim_devices_list
description: ''
operationId: dcim_devices_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: face
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: position
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_position
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_priority
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: local_context_data
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_type_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_full_depth
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: serial
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: has_primary_ip
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_chassis_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_chassis_member
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: console_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: console_server_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: power_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: power_outlets
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: interfaces
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: pass_through_ports
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_bays
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: face__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: position__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: position__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: position__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: position__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: position__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_position__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_position__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_position__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_position__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_position__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_priority__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_priority__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_priority__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_priority__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vc_priority__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_type_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_chassis_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_devices_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_devices_create
description: ''
operationId: dcim_devices_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceWithConfigContext'
deprecated: false
put:
tags:
- dcim
summary: dcim_devices_bulk_update
description: ''
operationId: dcim_devices_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceWithConfigContext'
deprecated: false
patch:
tags:
- dcim
summary: dcim_devices_bulk_partial_update
description: ''
operationId: dcim_devices_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceWithConfigContext'
deprecated: false
delete:
tags:
- dcim
summary: dcim_devices_bulk_delete
description: ''
operationId: dcim_devices_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/devices/{id}/:
get:
tags:
- dcim
summary: dcim_devices_read
description: ''
operationId: dcim_devices_read
parameters:
- name: id
in: path
description: A unique integer value identifying this device.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceWithConfigContext'
deprecated: false
put:
tags:
- dcim
summary: dcim_devices_update
description: ''
operationId: dcim_devices_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceWithConfigContext'
deprecated: false
patch:
tags:
- dcim
summary: dcim_devices_partial_update
description: ''
operationId: dcim_devices_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this device.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceWithConfigContext'
deprecated: false
delete:
tags:
- dcim
summary: dcim_devices_delete
description: ''
operationId: dcim_devices_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this device.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/devices/{id}/napalm/:
get:
tags:
- dcim
summary: dcim_devices_napalm
description: Execute a NAPALM method on a Device
operationId: dcim_devices_napalm
parameters:
- name: method
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this device.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceNAPALM'
deprecated: false
/dcim/front-port-templates/:
get:
tags:
- dcim
summary: dcim_front-port-templates_list
description: ''
operationId: dcim_front-port-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_front-port-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_front-port-templates_create
description: ''
operationId: dcim_front-port-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPortTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_front-port-templates_bulk_update
description: ''
operationId: dcim_front-port-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_front-port-templates_bulk_partial_update
description: ''
operationId: dcim_front-port-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_front-port-templates_bulk_delete
description: ''
operationId: dcim_front-port-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/front-port-templates/{id}/:
get:
tags:
- dcim
summary: dcim_front-port-templates_read
description: ''
operationId: dcim_front-port-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this front port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_front-port-templates_update
description: ''
operationId: dcim_front-port-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this front port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_front-port-templates_partial_update
description: ''
operationId: dcim_front-port-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this front port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_front-port-templates_delete
description: ''
operationId: dcim_front-port-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this front port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/front-ports/:
get:
tags:
- dcim
summary: dcim_front-ports_list
description: ''
operationId: dcim_front-ports_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_front-ports_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_front-ports_create
description: ''
operationId: dcim_front-ports_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPort'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_front-ports_bulk_update
description: ''
operationId: dcim_front-ports_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_front-ports_bulk_partial_update
description: ''
operationId: dcim_front-ports_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_front-ports_bulk_delete
description: ''
operationId: dcim_front-ports_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/front-ports/{id}/:
get:
tags:
- dcim
summary: dcim_front-ports_read
description: ''
operationId: dcim_front-ports_read
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_front-ports_update
description: ''
operationId: dcim_front-ports_update
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_front-ports_partial_update
description: ''
operationId: dcim_front-ports_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableFrontPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_front-ports_delete
description: ''
operationId: dcim_front-ports_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/front-ports/{id}/paths/:
get:
tags:
- dcim
summary: dcim_front-ports_paths
description: Return all CablePaths which traverse a given pass-through port.
operationId: dcim_front-ports_paths
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FrontPort'
deprecated: false
/dcim/interface-connections/:
get:
tags:
- dcim
summary: dcim_interface-connections_list
description: ''
operationId: dcim_interface-connections_list
parameters:
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_interface-connections_listResponse'
deprecated: false
/dcim/interface-templates/:
get:
tags:
- dcim
summary: dcim_interface-templates_list
description: ''
operationId: dcim_interface-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mgmt_only
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_interface-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_interface-templates_create
description: ''
operationId: dcim_interface-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterfaceTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_interface-templates_bulk_update
description: ''
operationId: dcim_interface-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterfaceTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_interface-templates_bulk_partial_update
description: ''
operationId: dcim_interface-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterfaceTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_interface-templates_bulk_delete
description: ''
operationId: dcim_interface-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/interface-templates/{id}/:
get:
tags:
- dcim
summary: dcim_interface-templates_read
description: ''
operationId: dcim_interface-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this interface template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_interface-templates_update
description: ''
operationId: dcim_interface-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this interface template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterfaceTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_interface-templates_partial_update
description: ''
operationId: dcim_interface-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this interface template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterfaceTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_interface-templates_delete
description: ''
operationId: dcim_interface-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this interface template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/interfaces/:
get:
tags:
- dcim
summary: dcim_interfaces_list
description: ''
operationId: dcim_interfaces_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: enabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mgmt_only
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mode
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: kind
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: lag_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vlan_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vlan
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mode__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: lag_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_interfaces_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_interfaces_create
description: ''
operationId: dcim_interfaces_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterface'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
put:
tags:
- dcim
summary: dcim_interfaces_bulk_update
description: ''
operationId: dcim_interfaces_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
patch:
tags:
- dcim
summary: dcim_interfaces_bulk_partial_update
description: ''
operationId: dcim_interfaces_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
delete:
tags:
- dcim
summary: dcim_interfaces_bulk_delete
description: ''
operationId: dcim_interfaces_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/interfaces/{id}/:
get:
tags:
- dcim
summary: dcim_interfaces_read
description: ''
operationId: dcim_interfaces_read
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
put:
tags:
- dcim
summary: dcim_interfaces_update
description: ''
operationId: dcim_interfaces_update
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
patch:
tags:
- dcim
summary: dcim_interfaces_partial_update
description: ''
operationId: dcim_interfaces_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
delete:
tags:
- dcim
summary: dcim_interfaces_delete
description: ''
operationId: dcim_interfaces_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/interfaces/{id}/trace/:
get:
tags:
- dcim
summary: dcim_interfaces_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: dcim_interfaces_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interface'
deprecated: false
/dcim/inventory-items/:
get:
tags:
- dcim
summary: dcim_inventory-items_list
description: ''
operationId: dcim_inventory-items_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: discovered
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: serial
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: part_id__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_inventory-items_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_inventory-items_create
description: ''
operationId: dcim_inventory-items_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInventoryItem'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItem'
deprecated: false
put:
tags:
- dcim
summary: dcim_inventory-items_bulk_update
description: ''
operationId: dcim_inventory-items_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInventoryItem'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItem'
deprecated: false
patch:
tags:
- dcim
summary: dcim_inventory-items_bulk_partial_update
description: ''
operationId: dcim_inventory-items_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInventoryItem'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItem'
deprecated: false
delete:
tags:
- dcim
summary: dcim_inventory-items_bulk_delete
description: ''
operationId: dcim_inventory-items_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/inventory-items/{id}/:
get:
tags:
- dcim
summary: dcim_inventory-items_read
description: ''
operationId: dcim_inventory-items_read
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItem'
deprecated: false
put:
tags:
- dcim
summary: dcim_inventory-items_update
description: ''
operationId: dcim_inventory-items_update
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInventoryItem'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItem'
deprecated: false
patch:
tags:
- dcim
summary: dcim_inventory-items_partial_update
description: ''
operationId: dcim_inventory-items_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableInventoryItem'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItem'
deprecated: false
delete:
tags:
- dcim
summary: dcim_inventory-items_delete
description: ''
operationId: dcim_inventory-items_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/manufacturers/:
get:
tags:
- dcim
summary: dcim_manufacturers_list
description: ''
operationId: dcim_manufacturers_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_manufacturers_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_manufacturers_create
description: ''
operationId: dcim_manufacturers_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
deprecated: false
put:
tags:
- dcim
summary: dcim_manufacturers_bulk_update
description: ''
operationId: dcim_manufacturers_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
deprecated: false
patch:
tags:
- dcim
summary: dcim_manufacturers_bulk_partial_update
description: ''
operationId: dcim_manufacturers_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
deprecated: false
delete:
tags:
- dcim
summary: dcim_manufacturers_bulk_delete
description: ''
operationId: dcim_manufacturers_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/manufacturers/{id}/:
get:
tags:
- dcim
summary: dcim_manufacturers_read
description: ''
operationId: dcim_manufacturers_read
parameters:
- name: id
in: path
description: A unique integer value identifying this manufacturer.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
deprecated: false
put:
tags:
- dcim
summary: dcim_manufacturers_update
description: ''
operationId: dcim_manufacturers_update
parameters:
- name: id
in: path
description: A unique integer value identifying this manufacturer.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
deprecated: false
patch:
tags:
- dcim
summary: dcim_manufacturers_partial_update
description: ''
operationId: dcim_manufacturers_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this manufacturer.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Manufacturer'
deprecated: false
delete:
tags:
- dcim
summary: dcim_manufacturers_delete
description: ''
operationId: dcim_manufacturers_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this manufacturer.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/platforms/:
get:
tags:
- dcim
summary: dcim_platforms_list
description: ''
operationId: dcim_platforms_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: napalm_driver__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: manufacturer__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_platforms_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_platforms_create
description: ''
operationId: dcim_platforms_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePlatform'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
deprecated: false
put:
tags:
- dcim
summary: dcim_platforms_bulk_update
description: ''
operationId: dcim_platforms_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePlatform'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
deprecated: false
patch:
tags:
- dcim
summary: dcim_platforms_bulk_partial_update
description: ''
operationId: dcim_platforms_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePlatform'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
deprecated: false
delete:
tags:
- dcim
summary: dcim_platforms_bulk_delete
description: ''
operationId: dcim_platforms_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/platforms/{id}/:
get:
tags:
- dcim
summary: dcim_platforms_read
description: ''
operationId: dcim_platforms_read
parameters:
- name: id
in: path
description: A unique integer value identifying this platform.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
deprecated: false
put:
tags:
- dcim
summary: dcim_platforms_update
description: ''
operationId: dcim_platforms_update
parameters:
- name: id
in: path
description: A unique integer value identifying this platform.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePlatform'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
deprecated: false
patch:
tags:
- dcim
summary: dcim_platforms_partial_update
description: ''
operationId: dcim_platforms_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this platform.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePlatform'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
deprecated: false
delete:
tags:
- dcim
summary: dcim_platforms_delete
description: ''
operationId: dcim_platforms_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this platform.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-connections/:
get:
tags:
- dcim
summary: dcim_power-connections_list
description: ''
operationId: dcim_power-connections_list
parameters:
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-connections_listResponse'
deprecated: false
/dcim/power-feeds/:
get:
tags:
- dcim
summary: dcim_power-feeds_list
description: ''
operationId: dcim_power-feeds_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: supply
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: phase
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: voltage
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: amperage
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: max_utilization
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: power_panel_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: supply__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: phase__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: voltage__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: voltage__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: voltage__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: voltage__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: voltage__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: amperage__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: amperage__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: amperage__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: amperage__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: amperage__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: max_utilization__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: max_utilization__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: max_utilization__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: max_utilization__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: max_utilization__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: power_panel_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-feeds_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_power-feeds_create
description: ''
operationId: dcim_power-feeds_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerFeed'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-feeds_bulk_update
description: ''
operationId: dcim_power-feeds_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerFeed'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-feeds_bulk_partial_update
description: ''
operationId: dcim_power-feeds_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerFeed'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-feeds_bulk_delete
description: ''
operationId: dcim_power-feeds_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-feeds/{id}/:
get:
tags:
- dcim
summary: dcim_power-feeds_read
description: ''
operationId: dcim_power-feeds_read
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-feeds_update
description: ''
operationId: dcim_power-feeds_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerFeed'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-feeds_partial_update
description: ''
operationId: dcim_power-feeds_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerFeed'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-feeds_delete
description: ''
operationId: dcim_power-feeds_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-feeds/{id}/trace/:
get:
tags:
- dcim
summary: dcim_power-feeds_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: dcim_power-feeds_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerFeed'
deprecated: false
/dcim/power-outlet-templates/:
get:
tags:
- dcim
summary: dcim_power-outlet-templates_list
description: ''
operationId: dcim_power-outlet-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: feed_leg
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: feed_leg__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-outlet-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_power-outlet-templates_create
description: ''
operationId: dcim_power-outlet-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutletTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutletTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-outlet-templates_bulk_update
description: ''
operationId: dcim_power-outlet-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutletTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutletTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-outlet-templates_bulk_partial_update
description: ''
operationId: dcim_power-outlet-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutletTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutletTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-outlet-templates_bulk_delete
description: ''
operationId: dcim_power-outlet-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-outlet-templates/{id}/:
get:
tags:
- dcim
summary: dcim_power-outlet-templates_read
description: ''
operationId: dcim_power-outlet-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutletTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-outlet-templates_update
description: ''
operationId: dcim_power-outlet-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutletTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutletTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-outlet-templates_partial_update
description: ''
operationId: dcim_power-outlet-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutletTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutletTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-outlet-templates_delete
description: ''
operationId: dcim_power-outlet-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-outlets/:
get:
tags:
- dcim
summary: dcim_power-outlets_list
description: ''
operationId: dcim_power-outlets_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: feed_leg
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: feed_leg__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-outlets_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_power-outlets_create
description: ''
operationId: dcim_power-outlets_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutlet'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-outlets_bulk_update
description: ''
operationId: dcim_power-outlets_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutlet'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-outlets_bulk_partial_update
description: ''
operationId: dcim_power-outlets_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutlet'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-outlets_bulk_delete
description: ''
operationId: dcim_power-outlets_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-outlets/{id}/:
get:
tags:
- dcim
summary: dcim_power-outlets_read
description: ''
operationId: dcim_power-outlets_read
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-outlets_update
description: ''
operationId: dcim_power-outlets_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutlet'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-outlets_partial_update
description: ''
operationId: dcim_power-outlets_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerOutlet'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-outlets_delete
description: ''
operationId: dcim_power-outlets_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-outlets/{id}/trace/:
get:
tags:
- dcim
summary: dcim_power-outlets_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: dcim_power-outlets_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerOutlet'
deprecated: false
/dcim/power-panels/:
get:
tags:
- dcim
summary: dcim_power-panels_list
description: ''
operationId: dcim_power-panels_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-panels_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_power-panels_create
description: ''
operationId: dcim_power-panels_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPanel'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPanel'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-panels_bulk_update
description: ''
operationId: dcim_power-panels_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPanel'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPanel'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-panels_bulk_partial_update
description: ''
operationId: dcim_power-panels_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPanel'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPanel'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-panels_bulk_delete
description: ''
operationId: dcim_power-panels_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-panels/{id}/:
get:
tags:
- dcim
summary: dcim_power-panels_read
description: ''
operationId: dcim_power-panels_read
parameters:
- name: id
in: path
description: A unique integer value identifying this power panel.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPanel'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-panels_update
description: ''
operationId: dcim_power-panels_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power panel.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPanel'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPanel'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-panels_partial_update
description: ''
operationId: dcim_power-panels_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power panel.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPanel'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPanel'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-panels_delete
description: ''
operationId: dcim_power-panels_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this power panel.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-port-templates/:
get:
tags:
- dcim
summary: dcim_power-port-templates_list
description: ''
operationId: dcim_power-port-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-port-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_power-port-templates_create
description: ''
operationId: dcim_power-port-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPortTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-port-templates_bulk_update
description: ''
operationId: dcim_power-port-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-port-templates_bulk_partial_update
description: ''
operationId: dcim_power-port-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-port-templates_bulk_delete
description: ''
operationId: dcim_power-port-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-port-templates/{id}/:
get:
tags:
- dcim
summary: dcim_power-port-templates_read
description: ''
operationId: dcim_power-port-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this power port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-port-templates_update
description: ''
operationId: dcim_power-port-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-port-templates_partial_update
description: ''
operationId: dcim_power-port-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-port-templates_delete
description: ''
operationId: dcim_power-port-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this power port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-ports/:
get:
tags:
- dcim
summary: dcim_power-ports_list
description: ''
operationId: dcim_power-ports_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: connected
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: maximum_draw__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: allocated_draw__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_power-ports_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_power-ports_create
description: ''
operationId: dcim_power-ports_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPort'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-ports_bulk_update
description: ''
operationId: dcim_power-ports_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-ports_bulk_partial_update
description: ''
operationId: dcim_power-ports_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-ports_bulk_delete
description: ''
operationId: dcim_power-ports_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-ports/{id}/:
get:
tags:
- dcim
summary: dcim_power-ports_read
description: ''
operationId: dcim_power-ports_read
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_power-ports_update
description: ''
operationId: dcim_power-ports_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_power-ports_partial_update
description: ''
operationId: dcim_power-ports_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePowerPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_power-ports_delete
description: ''
operationId: dcim_power-ports_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/power-ports/{id}/trace/:
get:
tags:
- dcim
summary: dcim_power-ports_trace
description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
operationId: dcim_power-ports_trace
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PowerPort'
deprecated: false
/dcim/rack-groups/:
get:
tags:
- dcim
summary: dcim_rack-groups_list
description: ''
operationId: dcim_rack-groups_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_rack-groups_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_rack-groups_create
description: ''
operationId: dcim_rack-groups_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackGroup'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackGroup'
deprecated: false
put:
tags:
- dcim
summary: dcim_rack-groups_bulk_update
description: ''
operationId: dcim_rack-groups_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackGroup'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rack-groups_bulk_partial_update
description: ''
operationId: dcim_rack-groups_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackGroup'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rack-groups_bulk_delete
description: ''
operationId: dcim_rack-groups_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rack-groups/{id}/:
get:
tags:
- dcim
summary: dcim_rack-groups_read
description: ''
operationId: dcim_rack-groups_read
parameters:
- name: id
in: path
description: A unique integer value identifying this rack group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackGroup'
deprecated: false
put:
tags:
- dcim
summary: dcim_rack-groups_update
description: ''
operationId: dcim_rack-groups_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackGroup'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rack-groups_partial_update
description: ''
operationId: dcim_rack-groups_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackGroup'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rack-groups_delete
description: ''
operationId: dcim_rack-groups_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this rack group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rack-reservations/:
get:
tags:
- dcim
summary: dcim_rack-reservations_list
description: ''
operationId: dcim_rack-reservations_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rack_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_rack-reservations_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_rack-reservations_create
description: ''
operationId: dcim_rack-reservations_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackReservation'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackReservation'
deprecated: false
put:
tags:
- dcim
summary: dcim_rack-reservations_bulk_update
description: ''
operationId: dcim_rack-reservations_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackReservation'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackReservation'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rack-reservations_bulk_partial_update
description: ''
operationId: dcim_rack-reservations_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackReservation'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackReservation'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rack-reservations_bulk_delete
description: ''
operationId: dcim_rack-reservations_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rack-reservations/{id}/:
get:
tags:
- dcim
summary: dcim_rack-reservations_read
description: ''
operationId: dcim_rack-reservations_read
parameters:
- name: id
in: path
description: A unique integer value identifying this rack reservation.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackReservation'
deprecated: false
put:
tags:
- dcim
summary: dcim_rack-reservations_update
description: ''
operationId: dcim_rack-reservations_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack reservation.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackReservation'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackReservation'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rack-reservations_partial_update
description: ''
operationId: dcim_rack-reservations_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack reservation.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRackReservation'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackReservation'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rack-reservations_delete
description: ''
operationId: dcim_rack-reservations_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this rack reservation.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rack-roles/:
get:
tags:
- dcim
summary: dcim_rack-roles_list
description: ''
operationId: dcim_rack-roles_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_rack-roles_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_rack-roles_create
description: ''
operationId: dcim_rack-roles_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
deprecated: false
put:
tags:
- dcim
summary: dcim_rack-roles_bulk_update
description: ''
operationId: dcim_rack-roles_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rack-roles_bulk_partial_update
description: ''
operationId: dcim_rack-roles_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rack-roles_bulk_delete
description: ''
operationId: dcim_rack-roles_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rack-roles/{id}/:
get:
tags:
- dcim
summary: dcim_rack-roles_read
description: ''
operationId: dcim_rack-roles_read
parameters:
- name: id
in: path
description: A unique integer value identifying this rack role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
deprecated: false
put:
tags:
- dcim
summary: dcim_rack-roles_update
description: ''
operationId: dcim_rack-roles_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rack-roles_partial_update
description: ''
operationId: dcim_rack-roles_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RackRole'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rack-roles_delete
description: ''
operationId: dcim_rack-roles_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this rack role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/racks/:
get:
tags:
- dcim
summary: dcim_racks_list
description: ''
operationId: dcim_racks_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: desc_units
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_width
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_depth
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_unit
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: width
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: serial
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility_id__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asset_tag__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: u_height__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_width__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_width__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_width__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_width__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_width__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_depth__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_depth__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_depth__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_depth__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_depth__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: outer_unit__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: width__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_racks_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_racks_create
description: ''
operationId: dcim_racks_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRack'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Rack'
deprecated: false
put:
tags:
- dcim
summary: dcim_racks_bulk_update
description: ''
operationId: dcim_racks_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRack'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Rack'
deprecated: false
patch:
tags:
- dcim
summary: dcim_racks_bulk_partial_update
description: ''
operationId: dcim_racks_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRack'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Rack'
deprecated: false
delete:
tags:
- dcim
summary: dcim_racks_bulk_delete
description: ''
operationId: dcim_racks_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/racks/{id}/:
get:
tags:
- dcim
summary: dcim_racks_read
description: ''
operationId: dcim_racks_read
parameters:
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Rack'
deprecated: false
put:
tags:
- dcim
summary: dcim_racks_update
description: ''
operationId: dcim_racks_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRack'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Rack'
deprecated: false
patch:
tags:
- dcim
summary: dcim_racks_partial_update
description: ''
operationId: dcim_racks_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRack'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Rack'
deprecated: false
delete:
tags:
- dcim
summary: dcim_racks_delete
description: ''
operationId: dcim_racks_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/racks/{id}/elevation/:
get:
tags:
- dcim
summary: dcim_racks_elevation
description: Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.
operationId: dcim_racks_elevation
parameters:
- name: q
in: query
description: ''
style: form
explode: true
schema:
minLength: 1
type: string
- name: face
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/face3'
- name: render
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/render'
- name: unit_width
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
default: 220
- name: unit_height
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
default: 22
- name: legend_width
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
default: 30
- name: exclude
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: expand_devices
in: query
description: ''
style: form
explode: true
schema:
type: boolean
default: true
- name: include_images
in: query
description: ''
style: form
explode: true
schema:
type: boolean
default: true
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RackUnit'
description: ''
deprecated: false
/dcim/rear-port-templates/:
get:
tags:
- dcim
summary: dcim_rear-port-templates_list
description: ''
operationId: dcim_rear-port-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: devicetype_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_rear-port-templates_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_rear-port-templates_create
description: ''
operationId: dcim_rear-port-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPortTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_rear-port-templates_bulk_update
description: ''
operationId: dcim_rear-port-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rear-port-templates_bulk_partial_update
description: ''
operationId: dcim_rear-port-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rear-port-templates_bulk_delete
description: ''
operationId: dcim_rear-port-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rear-port-templates/{id}/:
get:
tags:
- dcim
summary: dcim_rear-port-templates_read
description: ''
operationId: dcim_rear-port-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPortTemplate'
deprecated: false
put:
tags:
- dcim
summary: dcim_rear-port-templates_update
description: ''
operationId: dcim_rear-port-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPortTemplate'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rear-port-templates_partial_update
description: ''
operationId: dcim_rear-port-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPortTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPortTemplate'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rear-port-templates_delete
description: ''
operationId: dcim_rear-port-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rear-ports/:
get:
tags:
- dcim
summary: dcim_rear-ports_list
description: ''
operationId: dcim_rear-ports_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: positions__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_rear-ports_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_rear-ports_create
description: ''
operationId: dcim_rear-ports_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPort'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_rear-ports_bulk_update
description: ''
operationId: dcim_rear-ports_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rear-ports_bulk_partial_update
description: ''
operationId: dcim_rear-ports_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rear-ports_bulk_delete
description: ''
operationId: dcim_rear-ports_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rear-ports/{id}/:
get:
tags:
- dcim
summary: dcim_rear-ports_read
description: ''
operationId: dcim_rear-ports_read
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
put:
tags:
- dcim
summary: dcim_rear-ports_update
description: ''
operationId: dcim_rear-ports_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
patch:
tags:
- dcim
summary: dcim_rear-ports_partial_update
description: ''
operationId: dcim_rear-ports_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRearPort'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
delete:
tags:
- dcim
summary: dcim_rear-ports_delete
description: ''
operationId: dcim_rear-ports_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/rear-ports/{id}/paths/:
get:
tags:
- dcim
summary: dcim_rear-ports_paths
description: Return all CablePaths which traverse a given pass-through port.
operationId: dcim_rear-ports_paths
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RearPort'
deprecated: false
/dcim/regions/:
get:
tags:
- dcim
summary: dcim_regions_list
description: ''
operationId: dcim_regions_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_regions_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_regions_create
description: ''
operationId: dcim_regions_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRegion'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
deprecated: false
put:
tags:
- dcim
summary: dcim_regions_bulk_update
description: ''
operationId: dcim_regions_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRegion'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
deprecated: false
patch:
tags:
- dcim
summary: dcim_regions_bulk_partial_update
description: ''
operationId: dcim_regions_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRegion'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
deprecated: false
delete:
tags:
- dcim
summary: dcim_regions_bulk_delete
description: ''
operationId: dcim_regions_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/regions/{id}/:
get:
tags:
- dcim
summary: dcim_regions_read
description: ''
operationId: dcim_regions_read
parameters:
- name: id
in: path
description: A unique integer value identifying this region.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
deprecated: false
put:
tags:
- dcim
summary: dcim_regions_update
description: ''
operationId: dcim_regions_update
parameters:
- name: id
in: path
description: A unique integer value identifying this region.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRegion'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
deprecated: false
patch:
tags:
- dcim
summary: dcim_regions_partial_update
description: ''
operationId: dcim_regions_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this region.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRegion'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
deprecated: false
delete:
tags:
- dcim
summary: dcim_regions_delete
description: ''
operationId: dcim_regions_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this region.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/sites/:
get:
tags:
- dcim
summary: dcim_sites_list
description: ''
operationId: dcim_sites_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: latitude
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: longitude
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: facility__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: asn__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: latitude__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: latitude__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: latitude__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: latitude__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: latitude__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: longitude__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: longitude__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: longitude__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: longitude__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: longitude__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_phone__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contact_email__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_sites_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_sites_create
description: ''
operationId: dcim_sites_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSite'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
deprecated: false
put:
tags:
- dcim
summary: dcim_sites_bulk_update
description: ''
operationId: dcim_sites_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSite'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
deprecated: false
patch:
tags:
- dcim
summary: dcim_sites_bulk_partial_update
description: ''
operationId: dcim_sites_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSite'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
deprecated: false
delete:
tags:
- dcim
summary: dcim_sites_bulk_delete
description: ''
operationId: dcim_sites_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/sites/{id}/:
get:
tags:
- dcim
summary: dcim_sites_read
description: ''
operationId: dcim_sites_read
parameters:
- name: id
in: path
description: A unique integer value identifying this site.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
deprecated: false
put:
tags:
- dcim
summary: dcim_sites_update
description: ''
operationId: dcim_sites_update
parameters:
- name: id
in: path
description: A unique integer value identifying this site.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSite'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
deprecated: false
patch:
tags:
- dcim
summary: dcim_sites_partial_update
description: ''
operationId: dcim_sites_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this site.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSite'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
deprecated: false
delete:
tags:
- dcim
summary: dcim_sites_delete
description: ''
operationId: dcim_sites_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this site.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/virtual-chassis/:
get:
tags:
- dcim
summary: dcim_virtual-chassis_list
description: ''
operationId: dcim_virtual-chassis_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: master_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: master
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: domain__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: master_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: master__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dcim_virtual-chassis_listResponse'
deprecated: false
post:
tags:
- dcim
summary: dcim_virtual-chassis_create
description: ''
operationId: dcim_virtual-chassis_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualChassis'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualChassis'
deprecated: false
put:
tags:
- dcim
summary: dcim_virtual-chassis_bulk_update
description: ''
operationId: dcim_virtual-chassis_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualChassis'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualChassis'
deprecated: false
patch:
tags:
- dcim
summary: dcim_virtual-chassis_bulk_partial_update
description: ''
operationId: dcim_virtual-chassis_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualChassis'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualChassis'
deprecated: false
delete:
tags:
- dcim
summary: dcim_virtual-chassis_bulk_delete
description: ''
operationId: dcim_virtual-chassis_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/dcim/virtual-chassis/{id}/:
get:
tags:
- dcim
summary: dcim_virtual-chassis_read
description: ''
operationId: dcim_virtual-chassis_read
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual chassis.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualChassis'
deprecated: false
put:
tags:
- dcim
summary: dcim_virtual-chassis_update
description: ''
operationId: dcim_virtual-chassis_update
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual chassis.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualChassis'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualChassis'
deprecated: false
patch:
tags:
- dcim
summary: dcim_virtual-chassis_partial_update
description: ''
operationId: dcim_virtual-chassis_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual chassis.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualChassis'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualChassis'
deprecated: false
delete:
tags:
- dcim
summary: dcim_virtual-chassis_delete
description: ''
operationId: dcim_virtual-chassis_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual chassis.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/config-contexts/:
get:
tags:
- extras
summary: extras_config-contexts_list
description: ''
operationId: extras_config-contexts_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_active
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_config-contexts_listResponse'
deprecated: false
post:
tags:
- extras
summary: extras_config-contexts_create
description: ''
operationId: extras_config-contexts_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConfigContext'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
deprecated: false
put:
tags:
- extras
summary: extras_config-contexts_bulk_update
description: ''
operationId: extras_config-contexts_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
deprecated: false
patch:
tags:
- extras
summary: extras_config-contexts_bulk_partial_update
description: ''
operationId: extras_config-contexts_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
deprecated: false
delete:
tags:
- extras
summary: extras_config-contexts_bulk_delete
description: ''
operationId: extras_config-contexts_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/config-contexts/{id}/:
get:
tags:
- extras
summary: extras_config-contexts_read
description: ''
operationId: extras_config-contexts_read
parameters:
- name: id
in: path
description: A unique integer value identifying this config context.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
deprecated: false
put:
tags:
- extras
summary: extras_config-contexts_update
description: ''
operationId: extras_config-contexts_update
parameters:
- name: id
in: path
description: A unique integer value identifying this config context.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
deprecated: false
patch:
tags:
- extras
summary: extras_config-contexts_partial_update
description: ''
operationId: extras_config-contexts_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this config context.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
deprecated: false
delete:
tags:
- extras
summary: extras_config-contexts_delete
description: ''
operationId: extras_config-contexts_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this config context.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/content-types/:
get:
tags:
- extras
summary: extras_content-types_list
description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.
operationId: extras_content-types_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: app_label
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: model
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_content-types_listResponse'
deprecated: false
/extras/content-types/{id}/:
get:
tags:
- extras
summary: extras_content-types_read
description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.
operationId: extras_content-types_read
parameters:
- name: id
in: path
description: A unique integer value identifying this content type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ContentType'
deprecated: false
/extras/custom-fields/:
get:
tags:
- extras
summary: extras_custom-fields_list
description: ''
operationId: extras_custom-fields_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: content_types
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: required
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: filter_logic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: weight
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_custom-fields_listResponse'
deprecated: false
post:
tags:
- extras
summary: extras_custom-fields_create
description: ''
operationId: extras_custom-fields_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomField'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
deprecated: false
put:
tags:
- extras
summary: extras_custom-fields_bulk_update
description: ''
operationId: extras_custom-fields_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomField'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
deprecated: false
patch:
tags:
- extras
summary: extras_custom-fields_bulk_partial_update
description: ''
operationId: extras_custom-fields_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomField'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
deprecated: false
delete:
tags:
- extras
summary: extras_custom-fields_bulk_delete
description: ''
operationId: extras_custom-fields_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/custom-fields/{id}/:
get:
tags:
- extras
summary: extras_custom-fields_read
description: ''
operationId: extras_custom-fields_read
parameters:
- name: id
in: path
description: A unique integer value identifying this custom field.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
deprecated: false
put:
tags:
- extras
summary: extras_custom-fields_update
description: ''
operationId: extras_custom-fields_update
parameters:
- name: id
in: path
description: A unique integer value identifying this custom field.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomField'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
deprecated: false
patch:
tags:
- extras
summary: extras_custom-fields_partial_update
description: ''
operationId: extras_custom-fields_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this custom field.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomField'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
deprecated: false
delete:
tags:
- extras
summary: extras_custom-fields_delete
description: ''
operationId: extras_custom-fields_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this custom field.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/export-templates/:
get:
tags:
- extras
summary: extras_export-templates_list
description: ''
operationId: extras_export-templates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: content_type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: content_type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_export-templates_listResponse'
deprecated: false
post:
tags:
- extras
summary: extras_export-templates_create
description: ''
operationId: extras_export-templates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
deprecated: false
put:
tags:
- extras
summary: extras_export-templates_bulk_update
description: ''
operationId: extras_export-templates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
deprecated: false
patch:
tags:
- extras
summary: extras_export-templates_bulk_partial_update
description: ''
operationId: extras_export-templates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
deprecated: false
delete:
tags:
- extras
summary: extras_export-templates_bulk_delete
description: ''
operationId: extras_export-templates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/export-templates/{id}/:
get:
tags:
- extras
summary: extras_export-templates_read
description: ''
operationId: extras_export-templates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this export template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
deprecated: false
put:
tags:
- extras
summary: extras_export-templates_update
description: ''
operationId: extras_export-templates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this export template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
deprecated: false
patch:
tags:
- extras
summary: extras_export-templates_partial_update
description: ''
operationId: extras_export-templates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this export template.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
deprecated: false
delete:
tags:
- extras
summary: extras_export-templates_delete
description: ''
operationId: extras_export-templates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this export template.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/image-attachments/:
get:
tags:
- extras
summary: extras_image-attachments_list
description: ''
operationId: extras_image-attachments_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: content_type_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: content_type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: content_type_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: content_type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_image-attachments_listResponse'
deprecated: false
post:
tags:
- extras
summary: extras_image-attachments_create
description: ''
operationId: extras_image-attachments_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
deprecated: false
put:
tags:
- extras
summary: extras_image-attachments_bulk_update
description: ''
operationId: extras_image-attachments_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
deprecated: false
patch:
tags:
- extras
summary: extras_image-attachments_bulk_partial_update
description: ''
operationId: extras_image-attachments_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
deprecated: false
delete:
tags:
- extras
summary: extras_image-attachments_bulk_delete
description: ''
operationId: extras_image-attachments_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/image-attachments/{id}/:
get:
tags:
- extras
summary: extras_image-attachments_read
description: ''
operationId: extras_image-attachments_read
parameters:
- name: id
in: path
description: A unique integer value identifying this image attachment.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
deprecated: false
put:
tags:
- extras
summary: extras_image-attachments_update
description: ''
operationId: extras_image-attachments_update
parameters:
- name: id
in: path
description: A unique integer value identifying this image attachment.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
deprecated: false
patch:
tags:
- extras
summary: extras_image-attachments_partial_update
description: ''
operationId: extras_image-attachments_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this image attachment.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
deprecated: false
delete:
tags:
- extras
summary: extras_image-attachments_delete
description: ''
operationId: extras_image-attachments_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this image attachment.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/job-results/:
get:
tags:
- extras
summary: extras_job-results_list
description: Retrieve a list of job results
operationId: extras_job-results_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: completed
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: obj_type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: obj_type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_job-results_listResponse'
deprecated: false
/extras/job-results/{id}/:
get:
tags:
- extras
summary: extras_job-results_read
description: Retrieve a list of job results
operationId: extras_job-results_read
parameters:
- name: id
in: path
description: A unique integer value identifying this job result.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/JobResult'
deprecated: false
/extras/object-changes/:
get:
tags:
- extras
summary: extras_object-changes_list
description: Retrieve a list of recent changes.
operationId: extras_object-changes_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: request_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: action
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_type_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: time
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: action__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_type_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_repr__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: changed_object_type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_object-changes_listResponse'
deprecated: false
/extras/object-changes/{id}/:
get:
tags:
- extras
summary: extras_object-changes_read
description: Retrieve a list of recent changes.
operationId: extras_object-changes_read
parameters:
- name: id
in: path
description: A unique integer value identifying this object change.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectChange'
deprecated: false
/extras/reports/:
get:
tags:
- extras
summary: extras_reports_list
description: Compile all reports and their related results (if any). Result data is deferred in the list view.
operationId: extras_reports_list
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/extras/reports/{id}/:
get:
tags:
- extras
summary: extras_reports_read
description: Retrieve a single Report identified as "<module>.<report>".
operationId: extras_reports_read
parameters:
- name: id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/extras/reports/{id}/run/:
post:
tags:
- extras
summary: extras_reports_run
description: Run a Report identified as "<module>.<script>" and return the pending JobResult as the result
operationId: extras_reports_run
parameters:
- name: id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'201':
description: ''
headers: {}
content: {}
deprecated: false
/extras/scripts/:
get:
tags:
- extras
summary: extras_scripts_list
description: ''
operationId: extras_scripts_list
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/extras/scripts/{id}/:
get:
tags:
- extras
summary: extras_scripts_read
description: ''
operationId: extras_scripts_read
parameters:
- name: id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/extras/tags/:
get:
tags:
- extras
summary: extras_tags_list
description: ''
operationId: extras_tags_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: color__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/extras_tags_listResponse'
deprecated: false
post:
tags:
- extras
summary: extras_tags_create
description: ''
operationId: extras_tags_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
deprecated: false
put:
tags:
- extras
summary: extras_tags_bulk_update
description: ''
operationId: extras_tags_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
deprecated: false
patch:
tags:
- extras
summary: extras_tags_bulk_partial_update
description: ''
operationId: extras_tags_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
deprecated: false
delete:
tags:
- extras
summary: extras_tags_bulk_delete
description: ''
operationId: extras_tags_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/extras/tags/{id}/:
get:
tags:
- extras
summary: extras_tags_read
description: ''
operationId: extras_tags_read
parameters:
- name: id
in: path
description: A unique integer value identifying this tag.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
deprecated: false
put:
tags:
- extras
summary: extras_tags_update
description: ''
operationId: extras_tags_update
parameters:
- name: id
in: path
description: A unique integer value identifying this tag.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
deprecated: false
patch:
tags:
- extras
summary: extras_tags_partial_update
description: ''
operationId: extras_tags_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this tag.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
deprecated: false
delete:
tags:
- extras
summary: extras_tags_delete
description: ''
operationId: extras_tags_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this tag.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/aggregates/:
get:
tags:
- ipam
summary: ipam_aggregates_list
description: ''
operationId: ipam_aggregates_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: date_added
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: family
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: prefix
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rir_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rir
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: date_added__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: date_added__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: date_added__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: date_added__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: date_added__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rir_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rir__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_aggregates_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_aggregates_create
description: ''
operationId: ipam_aggregates_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableAggregate'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Aggregate'
deprecated: false
put:
tags:
- ipam
summary: ipam_aggregates_bulk_update
description: ''
operationId: ipam_aggregates_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableAggregate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Aggregate'
deprecated: false
patch:
tags:
- ipam
summary: ipam_aggregates_bulk_partial_update
description: ''
operationId: ipam_aggregates_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableAggregate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Aggregate'
deprecated: false
delete:
tags:
- ipam
summary: ipam_aggregates_bulk_delete
description: ''
operationId: ipam_aggregates_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/aggregates/{id}/:
get:
tags:
- ipam
summary: ipam_aggregates_read
description: ''
operationId: ipam_aggregates_read
parameters:
- name: id
in: path
description: A unique integer value identifying this aggregate.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Aggregate'
deprecated: false
put:
tags:
- ipam
summary: ipam_aggregates_update
description: ''
operationId: ipam_aggregates_update
parameters:
- name: id
in: path
description: A unique integer value identifying this aggregate.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableAggregate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Aggregate'
deprecated: false
patch:
tags:
- ipam
summary: ipam_aggregates_partial_update
description: ''
operationId: ipam_aggregates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this aggregate.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableAggregate'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Aggregate'
deprecated: false
delete:
tags:
- ipam
summary: ipam_aggregates_delete
description: ''
operationId: ipam_aggregates_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this aggregate.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/ip-addresses/:
get:
tags:
- ipam
summary: ipam_ip-addresses_list
description: ''
operationId: ipam_ip-addresses_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: family
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: parent
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: address
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mask_length
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: vrf_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vrf
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: present_in_vrf_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: present_in_vrf
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: interface
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: interface_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vminterface
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vminterface_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: assigned_to_interface
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: dns_name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vrf_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vrf__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: interface__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: interface_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vminterface__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vminterface_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_ip-addresses_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_ip-addresses_create
description: ''
operationId: ipam_ip-addresses_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableIPAddress'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IPAddress'
deprecated: false
put:
tags:
- ipam
summary: ipam_ip-addresses_bulk_update
description: ''
operationId: ipam_ip-addresses_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableIPAddress'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IPAddress'
deprecated: false
patch:
tags:
- ipam
summary: ipam_ip-addresses_bulk_partial_update
description: ''
operationId: ipam_ip-addresses_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableIPAddress'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IPAddress'
deprecated: false
delete:
tags:
- ipam
summary: ipam_ip-addresses_bulk_delete
description: ''
operationId: ipam_ip-addresses_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/ip-addresses/{id}/:
get:
tags:
- ipam
summary: ipam_ip-addresses_read
description: ''
operationId: ipam_ip-addresses_read
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IPAddress'
deprecated: false
put:
tags:
- ipam
summary: ipam_ip-addresses_update
description: ''
operationId: ipam_ip-addresses_update
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableIPAddress'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IPAddress'
deprecated: false
patch:
tags:
- ipam
summary: ipam_ip-addresses_partial_update
description: ''
operationId: ipam_ip-addresses_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableIPAddress'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IPAddress'
deprecated: false
delete:
tags:
- ipam
summary: ipam_ip-addresses_delete
description: ''
operationId: ipam_ip-addresses_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/prefixes/:
get:
tags:
- ipam
summary: ipam_prefixes_list
description: ''
operationId: ipam_prefixes_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_pool
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: family
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: prefix
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: within
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: within_include
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: contains
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mask_length
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: mask_length__gte
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: mask_length__lte
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: vrf_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vrf
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: present_in_vrf_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: present_in_vrf
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vlan_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vlan_vid
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vrf_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vrf__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vlan_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_prefixes_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_prefixes_create
description: ''
operationId: ipam_prefixes_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePrefix'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
put:
tags:
- ipam
summary: ipam_prefixes_bulk_update
description: ''
operationId: ipam_prefixes_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePrefix'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
patch:
tags:
- ipam
summary: ipam_prefixes_bulk_partial_update
description: ''
operationId: ipam_prefixes_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePrefix'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
delete:
tags:
- ipam
summary: ipam_prefixes_bulk_delete
description: ''
operationId: ipam_prefixes_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/prefixes/{id}/:
get:
tags:
- ipam
summary: ipam_prefixes_read
description: ''
operationId: ipam_prefixes_read
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
put:
tags:
- ipam
summary: ipam_prefixes_update
description: ''
operationId: ipam_prefixes_update
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePrefix'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
patch:
tags:
- ipam
summary: ipam_prefixes_partial_update
description: ''
operationId: ipam_prefixes_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritablePrefix'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
delete:
tags:
- ipam
summary: ipam_prefixes_delete
description: ''
operationId: ipam_prefixes_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/prefixes/{id}/available-ips/:
get:
tags:
- ipam
summary: ipam_prefixes_available-ips_read
description: >-
A convenience method for returning available IP addresses within a prefix. By default, the number of IPs
returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,
however results will not be paginated.
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
invoked in parallel, which results in a race condition where multiple insertions can occur.
operationId: ipam_prefixes_available-ips_read
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AvailableIP'
description: ''
deprecated: false
post:
tags:
- ipam
summary: ipam_prefixes_available-ips_create
description: >-
A convenience method for returning available IP addresses within a prefix. By default, the number of IPs
returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,
however results will not be paginated.
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
invoked in parallel, which results in a race condition where multiple insertions can occur.
operationId: ipam_prefixes_available-ips_create
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AvailableIP'
description: ''
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AvailableIP'
description: ''
deprecated: false
/ipam/prefixes/{id}/available-prefixes/:
get:
tags:
- ipam
summary: ipam_prefixes_available-prefixes_read
description: >-
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
invoked in parallel, which results in a race condition where multiple insertions can occur.
operationId: ipam_prefixes_available-prefixes_read
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AvailablePrefix'
description: ''
deprecated: false
post:
tags:
- ipam
summary: ipam_prefixes_available-prefixes_create
description: >-
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
invoked in parallel, which results in a race condition where multiple insertions can occur.
operationId: ipam_prefixes_available-prefixes_create
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PrefixLength'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Prefix'
deprecated: false
/ipam/rirs/:
get:
tags:
- ipam
summary: ipam_rirs_list
description: ''
operationId: ipam_rirs_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_private
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_rirs_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_rirs_create
description: ''
operationId: ipam_rirs_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
deprecated: false
put:
tags:
- ipam
summary: ipam_rirs_bulk_update
description: ''
operationId: ipam_rirs_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
deprecated: false
patch:
tags:
- ipam
summary: ipam_rirs_bulk_partial_update
description: ''
operationId: ipam_rirs_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
deprecated: false
delete:
tags:
- ipam
summary: ipam_rirs_bulk_delete
description: ''
operationId: ipam_rirs_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/rirs/{id}/:
get:
tags:
- ipam
summary: ipam_rirs_read
description: ''
operationId: ipam_rirs_read
parameters:
- name: id
in: path
description: A unique integer value identifying this RIR.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
deprecated: false
put:
tags:
- ipam
summary: ipam_rirs_update
description: ''
operationId: ipam_rirs_update
parameters:
- name: id
in: path
description: A unique integer value identifying this RIR.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
deprecated: false
patch:
tags:
- ipam
summary: ipam_rirs_partial_update
description: ''
operationId: ipam_rirs_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this RIR.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RIR'
deprecated: false
delete:
tags:
- ipam
summary: ipam_rirs_delete
description: ''
operationId: ipam_rirs_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this RIR.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/roles/:
get:
tags:
- ipam
summary: ipam_roles_list
description: ''
operationId: ipam_roles_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_roles_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_roles_create
description: ''
operationId: ipam_roles_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
deprecated: false
put:
tags:
- ipam
summary: ipam_roles_bulk_update
description: ''
operationId: ipam_roles_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
deprecated: false
patch:
tags:
- ipam
summary: ipam_roles_bulk_partial_update
description: ''
operationId: ipam_roles_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
deprecated: false
delete:
tags:
- ipam
summary: ipam_roles_bulk_delete
description: ''
operationId: ipam_roles_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/roles/{id}/:
get:
tags:
- ipam
summary: ipam_roles_read
description: ''
operationId: ipam_roles_read
parameters:
- name: id
in: path
description: A unique integer value identifying this role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
deprecated: false
put:
tags:
- ipam
summary: ipam_roles_update
description: ''
operationId: ipam_roles_update
parameters:
- name: id
in: path
description: A unique integer value identifying this role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
deprecated: false
patch:
tags:
- ipam
summary: ipam_roles_partial_update
description: ''
operationId: ipam_roles_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
deprecated: false
delete:
tags:
- ipam
summary: ipam_roles_delete
description: ''
operationId: ipam_roles_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/route-targets/:
get:
tags:
- ipam
summary: ipam_route-targets_list
description: ''
operationId: ipam_route-targets_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: importing_vrf_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: importing_vrf
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: exporting_vrf_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: exporting_vrf
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: importing_vrf_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: importing_vrf__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: exporting_vrf_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: exporting_vrf__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_route-targets_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_route-targets_create
description: ''
operationId: ipam_route-targets_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRouteTarget'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RouteTarget'
deprecated: false
put:
tags:
- ipam
summary: ipam_route-targets_bulk_update
description: ''
operationId: ipam_route-targets_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRouteTarget'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RouteTarget'
deprecated: false
patch:
tags:
- ipam
summary: ipam_route-targets_bulk_partial_update
description: ''
operationId: ipam_route-targets_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRouteTarget'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RouteTarget'
deprecated: false
delete:
tags:
- ipam
summary: ipam_route-targets_bulk_delete
description: ''
operationId: ipam_route-targets_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/route-targets/{id}/:
get:
tags:
- ipam
summary: ipam_route-targets_read
description: ''
operationId: ipam_route-targets_read
parameters:
- name: id
in: path
description: A unique integer value identifying this route target.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RouteTarget'
deprecated: false
put:
tags:
- ipam
summary: ipam_route-targets_update
description: ''
operationId: ipam_route-targets_update
parameters:
- name: id
in: path
description: A unique integer value identifying this route target.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRouteTarget'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RouteTarget'
deprecated: false
patch:
tags:
- ipam
summary: ipam_route-targets_partial_update
description: ''
operationId: ipam_route-targets_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this route target.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableRouteTarget'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RouteTarget'
deprecated: false
delete:
tags:
- ipam
summary: ipam_route-targets_delete
description: ''
operationId: ipam_route-targets_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this route target.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/services/:
get:
tags:
- ipam
summary: ipam_services_list
description: ''
operationId: ipam_services_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: protocol
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: port
in: query
description: ''
style: form
explode: true
schema:
type: number
format: double
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: protocol__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_services_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_services_create
description: ''
operationId: ipam_services_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableService'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
deprecated: false
put:
tags:
- ipam
summary: ipam_services_bulk_update
description: ''
operationId: ipam_services_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableService'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
deprecated: false
patch:
tags:
- ipam
summary: ipam_services_bulk_partial_update
description: ''
operationId: ipam_services_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableService'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
deprecated: false
delete:
tags:
- ipam
summary: ipam_services_bulk_delete
description: ''
operationId: ipam_services_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/services/{id}/:
get:
tags:
- ipam
summary: ipam_services_read
description: ''
operationId: ipam_services_read
parameters:
- name: id
in: path
description: A unique integer value identifying this service.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
deprecated: false
put:
tags:
- ipam
summary: ipam_services_update
description: ''
operationId: ipam_services_update
parameters:
- name: id
in: path
description: A unique integer value identifying this service.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableService'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
deprecated: false
patch:
tags:
- ipam
summary: ipam_services_partial_update
description: ''
operationId: ipam_services_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this service.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableService'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
deprecated: false
delete:
tags:
- ipam
summary: ipam_services_delete
description: ''
operationId: ipam_services_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this service.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/vlan-groups/:
get:
tags:
- ipam
summary: ipam_vlan-groups_list
description: ''
operationId: ipam_vlan-groups_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_vlan-groups_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_vlan-groups_create
description: ''
operationId: ipam_vlan-groups_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLANGroup'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLANGroup'
deprecated: false
put:
tags:
- ipam
summary: ipam_vlan-groups_bulk_update
description: ''
operationId: ipam_vlan-groups_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLANGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLANGroup'
deprecated: false
patch:
tags:
- ipam
summary: ipam_vlan-groups_bulk_partial_update
description: ''
operationId: ipam_vlan-groups_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLANGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLANGroup'
deprecated: false
delete:
tags:
- ipam
summary: ipam_vlan-groups_bulk_delete
description: ''
operationId: ipam_vlan-groups_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/vlan-groups/{id}/:
get:
tags:
- ipam
summary: ipam_vlan-groups_read
description: ''
operationId: ipam_vlan-groups_read
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLANGroup'
deprecated: false
put:
tags:
- ipam
summary: ipam_vlan-groups_update
description: ''
operationId: ipam_vlan-groups_update
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLANGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLANGroup'
deprecated: false
patch:
tags:
- ipam
summary: ipam_vlan-groups_partial_update
description: ''
operationId: ipam_vlan-groups_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLANGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLANGroup'
deprecated: false
delete:
tags:
- ipam
summary: ipam_vlan-groups_delete
description: ''
operationId: ipam_vlan-groups_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/vlans/:
get:
tags:
- ipam
summary: ipam_vlans_list
description: ''
operationId: ipam_vlans_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vid
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vid__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vid__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vid__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vid__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vid__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_vlans_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_vlans_create
description: ''
operationId: ipam_vlans_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLAN'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLAN'
deprecated: false
put:
tags:
- ipam
summary: ipam_vlans_bulk_update
description: ''
operationId: ipam_vlans_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLAN'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLAN'
deprecated: false
patch:
tags:
- ipam
summary: ipam_vlans_bulk_partial_update
description: ''
operationId: ipam_vlans_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLAN'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLAN'
deprecated: false
delete:
tags:
- ipam
summary: ipam_vlans_bulk_delete
description: ''
operationId: ipam_vlans_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/vlans/{id}/:
get:
tags:
- ipam
summary: ipam_vlans_read
description: ''
operationId: ipam_vlans_read
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLAN'
deprecated: false
put:
tags:
- ipam
summary: ipam_vlans_update
description: ''
operationId: ipam_vlans_update
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLAN'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLAN'
deprecated: false
patch:
tags:
- ipam
summary: ipam_vlans_partial_update
description: ''
operationId: ipam_vlans_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVLAN'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VLAN'
deprecated: false
delete:
tags:
- ipam
summary: ipam_vlans_delete
description: ''
operationId: ipam_vlans_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/vrfs/:
get:
tags:
- ipam
summary: ipam_vrfs_list
description: ''
operationId: ipam_vrfs_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: enforce_unique
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: import_target_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: import_target
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: export_target_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: export_target
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: rd__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: import_target_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: import_target__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: export_target_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: export_target__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ipam_vrfs_listResponse'
deprecated: false
post:
tags:
- ipam
summary: ipam_vrfs_create
description: ''
operationId: ipam_vrfs_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVRF'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VRF'
deprecated: false
put:
tags:
- ipam
summary: ipam_vrfs_bulk_update
description: ''
operationId: ipam_vrfs_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVRF'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VRF'
deprecated: false
patch:
tags:
- ipam
summary: ipam_vrfs_bulk_partial_update
description: ''
operationId: ipam_vrfs_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVRF'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VRF'
deprecated: false
delete:
tags:
- ipam
summary: ipam_vrfs_bulk_delete
description: ''
operationId: ipam_vrfs_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/ipam/vrfs/{id}/:
get:
tags:
- ipam
summary: ipam_vrfs_read
description: ''
operationId: ipam_vrfs_read
parameters:
- name: id
in: path
description: A unique integer value identifying this VRF.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VRF'
deprecated: false
put:
tags:
- ipam
summary: ipam_vrfs_update
description: ''
operationId: ipam_vrfs_update
parameters:
- name: id
in: path
description: A unique integer value identifying this VRF.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVRF'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VRF'
deprecated: false
patch:
tags:
- ipam
summary: ipam_vrfs_partial_update
description: ''
operationId: ipam_vrfs_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this VRF.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVRF'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VRF'
deprecated: false
delete:
tags:
- ipam
summary: ipam_vrfs_delete
description: ''
operationId: ipam_vrfs_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this VRF.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/secrets/generate-rsa-key-pair/:
get:
tags:
- secrets
summary: secrets_generate-rsa-key-pair_list
description: >-
{
"public_key": "<public key>",
"private_key": "<private key>"
}
operationId: secrets_generate-rsa-key-pair_list
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/secrets/get-session-key/:
post:
tags:
- secrets
summary: secrets_get-session-key_create
description: >-
Retrieve a temporary session key to use for encrypting and decrypting secrets via the API. The user's private RSA
key is POSTed with the name `private_key`. An example:
curl -v -X POST -H "Authorization: Token <token>" -H "Accept: application/json; indent=4" \
--data-urlencode "private_key@<filename>" https://netbox/api/secrets/get-session-key/
This request will yield a base64-encoded session key to be included in an `X-Session-Key` header in future requests:
{
"session_key": "+8t4SI6XikgVmB5+/urhozx9O5qCQANyOk1MNe6taRf="
}
This endpoint accepts one optional parameter: `preserve_key`. If True and a session key exists, the existing session
key will be returned instead of a new one.
operationId: secrets_get-session-key_create
parameters: []
responses:
'201':
description: ''
headers: {}
content: {}
deprecated: false
/secrets/secret-roles/:
get:
tags:
- secrets
summary: secrets_secret-roles_list
description: ''
operationId: secrets_secret-roles_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/secrets_secret-roles_listResponse'
deprecated: false
post:
tags:
- secrets
summary: secrets_secret-roles_create
description: ''
operationId: secrets_secret-roles_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
deprecated: false
put:
tags:
- secrets
summary: secrets_secret-roles_bulk_update
description: ''
operationId: secrets_secret-roles_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
deprecated: false
patch:
tags:
- secrets
summary: secrets_secret-roles_bulk_partial_update
description: ''
operationId: secrets_secret-roles_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
deprecated: false
delete:
tags:
- secrets
summary: secrets_secret-roles_bulk_delete
description: ''
operationId: secrets_secret-roles_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/secrets/secret-roles/{id}/:
get:
tags:
- secrets
summary: secrets_secret-roles_read
description: ''
operationId: secrets_secret-roles_read
parameters:
- name: id
in: path
description: A unique integer value identifying this secret role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
deprecated: false
put:
tags:
- secrets
summary: secrets_secret-roles_update
description: ''
operationId: secrets_secret-roles_update
parameters:
- name: id
in: path
description: A unique integer value identifying this secret role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
deprecated: false
patch:
tags:
- secrets
summary: secrets_secret-roles_partial_update
description: ''
operationId: secrets_secret-roles_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this secret role.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecretRole'
deprecated: false
delete:
tags:
- secrets
summary: secrets_secret-roles_delete
description: ''
operationId: secrets_secret-roles_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this secret role.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/secrets/secrets/:
get:
tags:
- secrets
summary: secrets_secrets_list
description: ''
operationId: secrets_secrets_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: device_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/secrets_secrets_listResponse'
deprecated: false
post:
tags:
- secrets
summary: secrets_secrets_create
description: ''
operationId: secrets_secrets_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSecret'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
deprecated: false
put:
tags:
- secrets
summary: secrets_secrets_bulk_update
description: ''
operationId: secrets_secrets_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSecret'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
deprecated: false
patch:
tags:
- secrets
summary: secrets_secrets_bulk_partial_update
description: ''
operationId: secrets_secrets_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSecret'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
deprecated: false
delete:
tags:
- secrets
summary: secrets_secrets_bulk_delete
description: ''
operationId: secrets_secrets_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/secrets/secrets/{id}/:
get:
tags:
- secrets
summary: secrets_secrets_read
description: ''
operationId: secrets_secrets_read
parameters:
- name: id
in: path
description: A unique integer value identifying this secret.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
deprecated: false
put:
tags:
- secrets
summary: secrets_secrets_update
description: ''
operationId: secrets_secrets_update
parameters:
- name: id
in: path
description: A unique integer value identifying this secret.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSecret'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
deprecated: false
patch:
tags:
- secrets
summary: secrets_secrets_partial_update
description: ''
operationId: secrets_secrets_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this secret.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableSecret'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
deprecated: false
delete:
tags:
- secrets
summary: secrets_secrets_delete
description: ''
operationId: secrets_secrets_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this secret.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/status/:
get:
tags:
- status
summary: status_list
description: A lightweight read-only endpoint for conveying NetBox's current operational status.
operationId: status_list
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/tenancy/tenant-groups/:
get:
tags:
- tenancy
summary: tenancy_tenant-groups_list
description: ''
operationId: tenancy_tenant-groups_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: parent__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tenancy_tenant-groups_listResponse'
deprecated: false
post:
tags:
- tenancy
summary: tenancy_tenant-groups_create
description: ''
operationId: tenancy_tenant-groups_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenantGroup'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TenantGroup'
deprecated: false
put:
tags:
- tenancy
summary: tenancy_tenant-groups_bulk_update
description: ''
operationId: tenancy_tenant-groups_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenantGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TenantGroup'
deprecated: false
patch:
tags:
- tenancy
summary: tenancy_tenant-groups_bulk_partial_update
description: ''
operationId: tenancy_tenant-groups_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenantGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TenantGroup'
deprecated: false
delete:
tags:
- tenancy
summary: tenancy_tenant-groups_bulk_delete
description: ''
operationId: tenancy_tenant-groups_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/tenancy/tenant-groups/{id}/:
get:
tags:
- tenancy
summary: tenancy_tenant-groups_read
description: ''
operationId: tenancy_tenant-groups_read
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TenantGroup'
deprecated: false
put:
tags:
- tenancy
summary: tenancy_tenant-groups_update
description: ''
operationId: tenancy_tenant-groups_update
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenantGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TenantGroup'
deprecated: false
patch:
tags:
- tenancy
summary: tenancy_tenant-groups_partial_update
description: ''
operationId: tenancy_tenant-groups_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenantGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TenantGroup'
deprecated: false
delete:
tags:
- tenancy
summary: tenancy_tenant-groups_delete
description: ''
operationId: tenancy_tenant-groups_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/tenancy/tenants/:
get:
tags:
- tenancy
summary: tenancy_tenants_list
description: ''
operationId: tenancy_tenants_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tenancy_tenants_listResponse'
deprecated: false
post:
tags:
- tenancy
summary: tenancy_tenants_create
description: ''
operationId: tenancy_tenants_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenant'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
deprecated: false
put:
tags:
- tenancy
summary: tenancy_tenants_bulk_update
description: ''
operationId: tenancy_tenants_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenant'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
deprecated: false
patch:
tags:
- tenancy
summary: tenancy_tenants_bulk_partial_update
description: ''
operationId: tenancy_tenants_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenant'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
deprecated: false
delete:
tags:
- tenancy
summary: tenancy_tenants_bulk_delete
description: ''
operationId: tenancy_tenants_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/tenancy/tenants/{id}/:
get:
tags:
- tenancy
summary: tenancy_tenants_read
description: ''
operationId: tenancy_tenants_read
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
deprecated: false
put:
tags:
- tenancy
summary: tenancy_tenants_update
description: ''
operationId: tenancy_tenants_update
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenant'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
deprecated: false
patch:
tags:
- tenancy
summary: tenancy_tenants_partial_update
description: ''
operationId: tenancy_tenants_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableTenant'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
deprecated: false
delete:
tags:
- tenancy
summary: tenancy_tenants_delete
description: ''
operationId: tenancy_tenants_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/users/config/:
get:
tags:
- users
summary: users_config_list
description: Return the UserConfig for the currently authenticated User.
operationId: users_config_list
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/users/groups/:
get:
tags:
- users
summary: users_groups_list
description: ''
operationId: users_groups_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/users_groups_listResponse'
deprecated: false
post:
tags:
- users
summary: users_groups_create
description: ''
operationId: users_groups_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
put:
tags:
- users
summary: users_groups_bulk_update
description: ''
operationId: users_groups_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
patch:
tags:
- users
summary: users_groups_bulk_partial_update
description: ''
operationId: users_groups_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
delete:
tags:
- users
summary: users_groups_bulk_delete
description: ''
operationId: users_groups_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/users/groups/{id}/:
get:
tags:
- users
summary: users_groups_read
description: ''
operationId: users_groups_read
parameters:
- name: id
in: path
description: A unique integer value identifying this group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
put:
tags:
- users
summary: users_groups_update
description: ''
operationId: users_groups_update
parameters:
- name: id
in: path
description: A unique integer value identifying this group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
patch:
tags:
- users
summary: users_groups_partial_update
description: ''
operationId: users_groups_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
delete:
tags:
- users
summary: users_groups_delete
description: ''
operationId: users_groups_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/users/permissions/:
get:
tags:
- users
summary: users_permissions_list
description: ''
operationId: users_permissions_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: enabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_types
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: object_types__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: user__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/users_permissions_listResponse'
deprecated: false
post:
tags:
- users
summary: users_permissions_create
description: ''
operationId: users_permissions_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableObjectPermission'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectPermission'
deprecated: false
put:
tags:
- users
summary: users_permissions_bulk_update
description: ''
operationId: users_permissions_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableObjectPermission'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectPermission'
deprecated: false
patch:
tags:
- users
summary: users_permissions_bulk_partial_update
description: ''
operationId: users_permissions_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableObjectPermission'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectPermission'
deprecated: false
delete:
tags:
- users
summary: users_permissions_bulk_delete
description: ''
operationId: users_permissions_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/users/permissions/{id}/:
get:
tags:
- users
summary: users_permissions_read
description: ''
operationId: users_permissions_read
parameters:
- name: id
in: path
description: A unique integer value identifying this permission.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectPermission'
deprecated: false
put:
tags:
- users
summary: users_permissions_update
description: ''
operationId: users_permissions_update
parameters:
- name: id
in: path
description: A unique integer value identifying this permission.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableObjectPermission'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectPermission'
deprecated: false
patch:
tags:
- users
summary: users_permissions_partial_update
description: ''
operationId: users_permissions_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this permission.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableObjectPermission'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectPermission'
deprecated: false
delete:
tags:
- users
summary: users_permissions_delete
description: ''
operationId: users_permissions_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this permission.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/users/users/:
get:
tags:
- users
summary: users_users_list
description: ''
operationId: users_users_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_staff
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: is_active
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: username__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: first_name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: email__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/users_users_listResponse'
deprecated: false
post:
tags:
- users
summary: users_users_create
description: ''
operationId: users_users_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableUser'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/User'
deprecated: false
put:
tags:
- users
summary: users_users_bulk_update
description: ''
operationId: users_users_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableUser'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/User'
deprecated: false
patch:
tags:
- users
summary: users_users_bulk_partial_update
description: ''
operationId: users_users_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableUser'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/User'
deprecated: false
delete:
tags:
- users
summary: users_users_bulk_delete
description: ''
operationId: users_users_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/users/users/{id}/:
get:
tags:
- users
summary: users_users_read
description: ''
operationId: users_users_read
parameters:
- name: id
in: path
description: A unique integer value identifying this user.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/User'
deprecated: false
put:
tags:
- users
summary: users_users_update
description: ''
operationId: users_users_update
parameters:
- name: id
in: path
description: A unique integer value identifying this user.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableUser'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/User'
deprecated: false
patch:
tags:
- users
summary: users_users_partial_update
description: ''
operationId: users_users_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this user.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableUser'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/User'
deprecated: false
delete:
tags:
- users
summary: users_users_delete
description: ''
operationId: users_users_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this user.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/cluster-groups/:
get:
tags:
- virtualization
summary: virtualization_cluster-groups_list
description: ''
operationId: virtualization_cluster-groups_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/virtualization_cluster-groups_listResponse'
deprecated: false
post:
tags:
- virtualization
summary: virtualization_cluster-groups_create
description: ''
operationId: virtualization_cluster-groups_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_cluster-groups_bulk_update
description: ''
operationId: virtualization_cluster-groups_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_cluster-groups_bulk_partial_update
description: ''
operationId: virtualization_cluster-groups_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_cluster-groups_bulk_delete
description: ''
operationId: virtualization_cluster-groups_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/cluster-groups/{id}/:
get:
tags:
- virtualization
summary: virtualization_cluster-groups_read
description: ''
operationId: virtualization_cluster-groups_read
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_cluster-groups_update
description: ''
operationId: virtualization_cluster-groups_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_cluster-groups_partial_update
description: ''
operationId: virtualization_cluster-groups_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster group.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterGroup'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_cluster-groups_delete
description: ''
operationId: virtualization_cluster-groups_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster group.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/cluster-types/:
get:
tags:
- virtualization
summary: virtualization_cluster-types_list
description: ''
operationId: virtualization_cluster-types_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: slug__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: description__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/virtualization_cluster-types_listResponse'
deprecated: false
post:
tags:
- virtualization
summary: virtualization_cluster-types_create
description: ''
operationId: virtualization_cluster-types_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_cluster-types_bulk_update
description: ''
operationId: virtualization_cluster-types_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_cluster-types_bulk_partial_update
description: ''
operationId: virtualization_cluster-types_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_cluster-types_bulk_delete
description: ''
operationId: virtualization_cluster-types_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/cluster-types/{id}/:
get:
tags:
- virtualization
summary: virtualization_cluster-types_read
description: ''
operationId: virtualization_cluster-types_read
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_cluster-types_update
description: ''
operationId: virtualization_cluster-types_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster type.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_cluster-types_partial_update
description: ''
operationId: virtualization_cluster-types_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster type.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterType'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_cluster-types_delete
description: ''
operationId: virtualization_cluster-types_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster type.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/clusters/:
get:
tags:
- virtualization
summary: virtualization_clusters_list
description: ''
operationId: virtualization_clusters_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/virtualization_clusters_listResponse'
deprecated: false
post:
tags:
- virtualization
summary: virtualization_clusters_create
description: ''
operationId: virtualization_clusters_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCluster'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_clusters_bulk_update
description: ''
operationId: virtualization_clusters_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCluster'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_clusters_bulk_partial_update
description: ''
operationId: virtualization_clusters_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCluster'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_clusters_bulk_delete
description: ''
operationId: virtualization_clusters_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/clusters/{id}/:
get:
tags:
- virtualization
summary: virtualization_clusters_read
description: ''
operationId: virtualization_clusters_read
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_clusters_update
description: ''
operationId: virtualization_clusters_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCluster'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_clusters_partial_update
description: ''
operationId: virtualization_clusters_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCluster'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_clusters_delete
description: ''
operationId: virtualization_clusters_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/interfaces/:
get:
tags:
- virtualization
summary: virtualization_interfaces_list
description: ''
operationId: virtualization_interfaces_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: enabled
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mtu__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: virtual_machine__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/virtualization_interfaces_listResponse'
deprecated: false
post:
tags:
- virtualization
summary: virtualization_interfaces_create
description: ''
operationId: virtualization_interfaces_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVMInterface'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VMInterface'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_interfaces_bulk_update
description: ''
operationId: virtualization_interfaces_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVMInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VMInterface'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_interfaces_bulk_partial_update
description: ''
operationId: virtualization_interfaces_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVMInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VMInterface'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_interfaces_bulk_delete
description: ''
operationId: virtualization_interfaces_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/interfaces/{id}/:
get:
tags:
- virtualization
summary: virtualization_interfaces_read
description: ''
operationId: virtualization_interfaces_read
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VMInterface'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_interfaces_update
description: ''
operationId: virtualization_interfaces_update
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVMInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VMInterface'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_interfaces_partial_update
description: ''
operationId: virtualization_interfaces_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVMInterface'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VMInterface'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_interfaces_delete
description: ''
operationId: virtualization_interfaces_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/virtual-machines/:
get:
tags:
- virtualization
summary: virtualization_virtual-machines_list
description: ''
operationId: virtualization_virtual-machines_list
parameters:
- name: id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vcpus
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: memory
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: disk
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: local_context_data
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: created__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: last_updated__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_type_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_type
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform_id
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: has_primary_ip
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: id__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: name__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vcpus__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vcpus__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vcpus__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vcpus__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vcpus__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: memory__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: memory__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: memory__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: memory__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: memory__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: disk__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: disk__lte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: disk__lt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: disk__gte
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: disk__gt
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tenant__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_group__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_type_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_type__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: cluster_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: region__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: site__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: role__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform_id__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: platform__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nic
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__iew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__niew
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__isw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nisw
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__ie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: mac_address__nie
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: tag__n
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of results to return per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: The initial index from which to return the results.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/virtualization_virtual-machines_listResponse'
deprecated: false
post:
tags:
- virtualization
summary: virtualization_virtual-machines_create
description: ''
operationId: virtualization_virtual-machines_create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
required: true
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_virtual-machines_bulk_update
description: ''
operationId: virtualization_virtual-machines_bulk_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_virtual-machines_bulk_partial_update
description: ''
operationId: virtualization_virtual-machines_bulk_partial_update
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_virtual-machines_bulk_delete
description: ''
operationId: virtualization_virtual-machines_bulk_delete
parameters: []
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
/virtualization/virtual-machines/{id}/:
get:
tags:
- virtualization
summary: virtualization_virtual-machines_read
description: ''
operationId: virtualization_virtual-machines_read
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual machine.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
deprecated: false
put:
tags:
- virtualization
summary: virtualization_virtual-machines_update
description: ''
operationId: virtualization_virtual-machines_update
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual machine.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
deprecated: false
patch:
tags:
- virtualization
summary: virtualization_virtual-machines_partial_update
description: ''
operationId: virtualization_virtual-machines_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual machine.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
deprecated: false
delete:
tags:
- virtualization
summary: virtualization_virtual-machines_delete
description: ''
operationId: virtualization_virtual-machines_delete
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual machine.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: ''
headers: {}
content: {}
deprecated: false
components:
schemas:
NestedCircuit:
title: NestedCircuit
required:
- cid
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
cid:
maxLength: 100
minLength: 1
type: string
NestedSite:
title: NestedSite
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
NestedCable:
title: NestedCable
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
label:
maxLength: 100
type: string
CircuitTermination:
title: CircuitTermination
required:
- circuit
- term_side
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
circuit:
$ref: '#/components/schemas/NestedCircuit'
term_side:
$ref: '#/components/schemas/Termination'
site:
$ref: '#/components/schemas/NestedSite'
port_speed:
maximum: 2147483647
minimum: 0
type: integer
format: int32
upstream_speed:
maximum: 2147483647
minimum: 0
type: integer
description: Upstream speed, if different from port speed
format: int32
xconnect_id:
maxLength: 50
type: string
pp_info:
maxLength: 100
type: string
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
WritableCircuitTermination:
title: WritableCircuitTermination
required:
- circuit
- term_side
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
circuit:
type: integer
format: int32
term_side:
$ref: '#/components/schemas/Termination'
site:
type: integer
format: int32
port_speed:
maximum: 2147483647
minimum: 0
type: integer
format: int32
upstream_speed:
maximum: 2147483647
minimum: 0
type: integer
description: Upstream speed, if different from port speed
format: int32
xconnect_id:
maxLength: 50
type: string
pp_info:
maxLength: 100
type: string
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
CircuitType:
title: CircuitType
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
description:
maxLength: 200
type: string
circuit_count:
type: integer
format: int32
readOnly: true
NestedProvider:
title: NestedProvider
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
circuit_count:
type: integer
format: int32
readOnly: true
NestedCircuitType:
title: NestedCircuitType
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
circuit_count:
type: integer
format: int32
readOnly: true
NestedTenant:
title: NestedTenant
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
NestedDevice:
title: NestedDevice
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
type: string
display_name:
type: string
readOnly: true
NestedInterface:
title: NestedInterface
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
cable:
type: integer
format: int32
CircuitCircuitTermination:
title: CircuitCircuitTermination
required:
- site
- connected_endpoint
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
site:
$ref: '#/components/schemas/NestedSite'
connected_endpoint:
$ref: '#/components/schemas/NestedInterface'
port_speed:
maximum: 2147483647
minimum: 0
type: integer
format: int32
upstream_speed:
maximum: 2147483647
minimum: 0
type: integer
description: Upstream speed, if different from port speed
format: int32
xconnect_id:
maxLength: 50
type: string
NestedTag:
title: NestedTag
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
color:
maxLength: 6
minLength: 1
pattern: ^[0-9a-f]{6}$
type: string
Circuit:
title: Circuit
required:
- cid
- provider
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
cid:
maxLength: 100
minLength: 1
type: string
provider:
$ref: '#/components/schemas/NestedProvider'
type:
$ref: '#/components/schemas/NestedCircuitType'
status:
$ref: '#/components/schemas/Status'
tenant:
$ref: '#/components/schemas/NestedTenant'
install_date:
type: string
format: date
commit_rate:
maximum: 2147483647
minimum: 0
type: integer
format: int32
description:
maxLength: 200
type: string
termination_a:
$ref: '#/components/schemas/CircuitCircuitTermination'
termination_z:
$ref: '#/components/schemas/CircuitCircuitTermination'
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableCircuit:
title: WritableCircuit
required:
- cid
- provider
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
cid:
maxLength: 100
minLength: 1
type: string
provider:
type: integer
format: int32
type:
type: integer
format: int32
status:
$ref: '#/components/schemas/Status1'
tenant:
type: integer
format: int32
install_date:
type: string
format: date
commit_rate:
maximum: 2147483647
minimum: 0
type: integer
format: int32
description:
maxLength: 200
type: string
termination_a:
type: string
readOnly: true
termination_z:
type: string
readOnly: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
Provider:
title: Provider
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
asn:
maximum: 4294967295
minimum: 1
type: integer
description: 32-bit autonomous system number
format: int32
account:
maxLength: 30
type: string
portal_url:
maxLength: 200
type: string
noc_contact:
type: string
admin_contact:
type: string
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
circuit_count:
type: integer
format: int32
readOnly: true
Cable:
title: Cable
required:
- termination_a_type
- termination_a_id
- termination_b_type
- termination_b_id
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
termination_a_type:
type: string
termination_a_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
termination_a:
type: object
additionalProperties:
type: string
readOnly: true
termination_b_type:
type: string
termination_b_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
termination_b:
type: object
additionalProperties:
type: string
readOnly: true
type:
$ref: '#/components/schemas/Type'
status:
$ref: '#/components/schemas/Status2'
label:
maxLength: 100
type: string
color:
maxLength: 6
pattern: ^[0-9a-f]{6}$
type: string
length:
maximum: 32767
minimum: 0
type: integer
format: int32
length_unit:
$ref: '#/components/schemas/Lengthunit'
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
WritableCable:
title: WritableCable
required:
- termination_a_type
- termination_a_id
- termination_b_type
- termination_b_id
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
termination_a_type:
type: string
termination_a_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
termination_a:
type: object
additionalProperties:
type: string
readOnly: true
termination_b_type:
type: string
termination_b_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
termination_b:
type: object
additionalProperties:
type: string
readOnly: true
type:
$ref: '#/components/schemas/Type'
status:
$ref: '#/components/schemas/Status3'
label:
maxLength: 100
type: string
color:
maxLength: 6
pattern: ^[0-9a-f]{6}$
type: string
length:
maximum: 32767
minimum: 0
type: integer
format: int32
length_unit:
$ref: '#/components/schemas/Lengthunit1'
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
NestedManufacturer:
title: NestedManufacturer
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
devicetype_count:
type: integer
format: int32
readOnly: true
NestedDeviceType:
title: NestedDeviceType
required:
- model
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
manufacturer:
$ref: '#/components/schemas/NestedManufacturer'
model:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
display_name:
type: string
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
NestedDeviceRole:
title: NestedDeviceRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
NestedPlatform:
title: NestedPlatform
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
NestedRack:
title: NestedRack
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
display_name:
type: string
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
NestedIPAddress:
title: NestedIPAddress
required:
- address
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
type: integer
format: int32
readOnly: true
address:
type: string
description: IPv4 or IPv6 address (with mask)
NestedCluster:
title: NestedCluster
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
virtualmachine_count:
type: integer
format: int32
readOnly: true
NestedVirtualChassis:
title: NestedVirtualChassis
required:
- name
- master
type: object
properties:
id:
type: integer
format: int32
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
url:
type: string
readOnly: true
master:
$ref: '#/components/schemas/NestedDevice'
member_count:
type: integer
format: int32
readOnly: true
Device:
title: Device
required:
- device_type
- device_role
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
type: string
display_name:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
device_role:
$ref: '#/components/schemas/NestedDeviceRole'
tenant:
$ref: '#/components/schemas/NestedTenant'
platform:
$ref: '#/components/schemas/NestedPlatform'
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this device
site:
$ref: '#/components/schemas/NestedSite'
rack:
$ref: '#/components/schemas/NestedRack'
position:
maximum: 32767
minimum: 1
type: integer
description: The lowest-numbered unit occupied by the device
format: int32
face:
$ref: '#/components/schemas/Face'
parent_device:
$ref: '#/components/schemas/NestedDevice'
status:
$ref: '#/components/schemas/Status4'
primary_ip:
$ref: '#/components/schemas/NestedIPAddress'
primary_ip4:
$ref: '#/components/schemas/NestedIPAddress'
primary_ip6:
$ref: '#/components/schemas/NestedIPAddress'
cluster:
$ref: '#/components/schemas/NestedCluster'
virtual_chassis:
$ref: '#/components/schemas/NestedVirtualChassis'
vc_position:
maximum: 255
minimum: 0
type: integer
format: int32
vc_priority:
maximum: 255
minimum: 0
type: integer
format: int32
comments:
type: string
local_context_data:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
ConsolePort:
title: ConsolePort
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type2'
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
ConsolePortTemplate:
title: ConsolePortTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type2'
description:
maxLength: 200
type: string
WritableConsolePortTemplate:
title: WritableConsolePortTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type4'
description:
maxLength: 200
type: string
WritableConsolePort:
title: WritableConsolePort
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type5'
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
ConsoleServerPortTemplate:
title: ConsoleServerPortTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type2'
description:
maxLength: 200
type: string
WritableConsoleServerPortTemplate:
title: WritableConsoleServerPortTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type4'
description:
maxLength: 200
type: string
ConsoleServerPort:
title: ConsoleServerPort
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type2'
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
WritableConsoleServerPort:
title: WritableConsoleServerPort
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type5'
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
DeviceBayTemplate:
title: DeviceBayTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
description:
maxLength: 200
type: string
WritableDeviceBayTemplate:
title: WritableDeviceBayTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
description:
maxLength: 200
type: string
DeviceBay:
title: DeviceBay
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
description:
maxLength: 200
type: string
installed_device:
$ref: '#/components/schemas/NestedDevice'
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
WritableDeviceBay:
title: WritableDeviceBay
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
description:
maxLength: 200
type: string
installed_device:
type: integer
format: int32
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
DeviceRole:
title: DeviceRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
color:
maxLength: 6
minLength: 1
pattern: ^[0-9a-f]{6}$
type: string
vm_role:
type: boolean
description: Virtual machines may be assigned to this role
description:
maxLength: 200
type: string
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
DeviceType:
title: DeviceType
required:
- manufacturer
- model
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
manufacturer:
$ref: '#/components/schemas/NestedManufacturer'
model:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
display_name:
type: string
readOnly: true
part_number:
maxLength: 50
type: string
description: Discrete part number (optional)
u_height:
maximum: 32767
minimum: 0
type: integer
format: int32
is_full_depth:
type: boolean
description: Device consumes both front and rear rack faces
subdevice_role:
$ref: '#/components/schemas/Subdevicerole'
front_image:
type: string
readOnly: true
rear_image:
type: string
readOnly: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
WritableDeviceType:
title: WritableDeviceType
required:
- manufacturer
- model
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
manufacturer:
type: integer
format: int32
model:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
display_name:
type: string
readOnly: true
part_number:
maxLength: 50
type: string
description: Discrete part number (optional)
u_height:
maximum: 32767
minimum: 0
type: integer
format: int32
is_full_depth:
type: boolean
description: Device consumes both front and rear rack faces
subdevice_role:
$ref: '#/components/schemas/Parentchildstatus'
front_image:
type: string
readOnly: true
rear_image:
type: string
readOnly: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
DeviceWithConfigContext:
title: DeviceWithConfigContext
required:
- device_type
- device_role
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
type: string
display_name:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
device_role:
$ref: '#/components/schemas/NestedDeviceRole'
tenant:
$ref: '#/components/schemas/NestedTenant'
platform:
$ref: '#/components/schemas/NestedPlatform'
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this device
site:
$ref: '#/components/schemas/NestedSite'
rack:
$ref: '#/components/schemas/NestedRack'
position:
maximum: 32767
minimum: 1
type: integer
description: The lowest-numbered unit occupied by the device
format: int32
face:
$ref: '#/components/schemas/Face'
parent_device:
$ref: '#/components/schemas/NestedDevice'
status:
$ref: '#/components/schemas/Status4'
primary_ip:
$ref: '#/components/schemas/NestedIPAddress'
primary_ip4:
$ref: '#/components/schemas/NestedIPAddress'
primary_ip6:
$ref: '#/components/schemas/NestedIPAddress'
cluster:
$ref: '#/components/schemas/NestedCluster'
virtual_chassis:
$ref: '#/components/schemas/NestedVirtualChassis'
vc_position:
maximum: 255
minimum: 0
type: integer
format: int32
vc_priority:
maximum: 255
minimum: 0
type: integer
format: int32
comments:
type: string
local_context_data:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
config_context:
type: object
additionalProperties:
type: string
readOnly: true
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableDeviceWithConfigContext:
title: WritableDeviceWithConfigContext
required:
- device_type
- device_role
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
type: string
display_name:
type: string
readOnly: true
device_type:
type: integer
format: int32
device_role:
type: integer
format: int32
tenant:
type: integer
format: int32
platform:
type: integer
format: int32
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this device
site:
type: integer
format: int32
rack:
type: integer
format: int32
position:
maximum: 32767
minimum: 1
type: integer
description: The lowest-numbered unit occupied by the device
format: int32
face:
$ref: '#/components/schemas/Rackface'
parent_device:
$ref: '#/components/schemas/NestedDevice'
status:
$ref: '#/components/schemas/Status6'
primary_ip:
type: string
readOnly: true
primary_ip4:
type: integer
format: int32
primary_ip6:
type: integer
format: int32
cluster:
type: integer
format: int32
virtual_chassis:
type: integer
format: int32
vc_position:
maximum: 255
minimum: 0
type: integer
format: int32
vc_priority:
maximum: 255
minimum: 0
type: integer
format: int32
comments:
type: string
local_context_data:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
config_context:
type: object
additionalProperties:
type: string
readOnly: true
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
DeviceNAPALM:
title: DeviceNAPALM
required:
- method
type: object
properties:
method:
type: object
additionalProperties:
type: string
NestedRearPortTemplate:
title: NestedRearPortTemplate
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
FrontPortTemplate:
title: FrontPortTemplate
required:
- device_type
- name
- type
- rear_port
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type10'
rear_port:
$ref: '#/components/schemas/NestedRearPortTemplate'
rear_port_position:
maximum: 1024
minimum: 1
type: integer
format: int32
default: 1
description:
maxLength: 200
type: string
WritableFrontPortTemplate:
title: WritableFrontPortTemplate
required:
- device_type
- name
- type
- rear_port
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type11'
rear_port:
type: integer
format: int32
rear_port_position:
maximum: 1024
minimum: 1
type: integer
format: int32
default: 1
description:
maxLength: 200
type: string
FrontPortRearPort:
title: FrontPortRearPort
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
FrontPort:
title: FrontPort
required:
- device
- name
- type
- rear_port
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type10'
rear_port:
$ref: '#/components/schemas/FrontPortRearPort'
rear_port_position:
maximum: 1024
minimum: 1
type: integer
format: int32
default: 1
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
WritableFrontPort:
title: WritableFrontPort
required:
- device
- name
- type
- rear_port
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type11'
rear_port:
type: integer
format: int32
rear_port_position:
maximum: 1024
minimum: 1
type: integer
format: int32
default: 1
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
InterfaceConnection:
title: InterfaceConnection
required:
- interface_b
type: object
properties:
interface_a:
$ref: '#/components/schemas/NestedInterface'
interface_b:
$ref: '#/components/schemas/NestedInterface'
connected_endpoint_reachable:
type: boolean
readOnly: true
InterfaceTemplate:
title: InterfaceTemplate
required:
- device_type
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type14'
mgmt_only:
type: boolean
description:
maxLength: 200
type: string
WritableInterfaceTemplate:
title: WritableInterfaceTemplate
required:
- device_type
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type15'
mgmt_only:
type: boolean
description:
maxLength: 200
type: string
NestedVLAN:
title: NestedVLAN
required:
- vid
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
vid:
maximum: 4094
minimum: 1
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
display_name:
type: string
readOnly: true
Interface:
title: Interface
required:
- device
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type14'
enabled:
type: boolean
lag:
$ref: '#/components/schemas/NestedInterface'
mtu:
maximum: 65536
minimum: 1
type: integer
format: int32
mac_address:
type: string
mgmt_only:
type: boolean
description: This interface is used only for out-of-band management
description:
maxLength: 200
type: string
mode:
$ref: '#/components/schemas/Mode'
untagged_vlan:
$ref: '#/components/schemas/NestedVLAN'
tagged_vlans:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedVLAN'
description: ''
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
count_ipaddresses:
type: integer
format: int32
readOnly: true
WritableInterface:
title: WritableInterface
required:
- device
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type15'
enabled:
type: boolean
lag:
type: integer
format: int32
mtu:
maximum: 65536
minimum: 1
type: integer
format: int32
mac_address:
type: string
mgmt_only:
type: boolean
description: This interface is used only for out-of-band management
description:
maxLength: 200
type: string
mode:
$ref: '#/components/schemas/Mode1'
untagged_vlan:
type: integer
format: int32
tagged_vlans:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
count_ipaddresses:
type: integer
format: int32
readOnly: true
InventoryItem:
title: InventoryItem
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
parent:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
manufacturer:
$ref: '#/components/schemas/NestedManufacturer'
part_id:
maxLength: 50
type: string
description: Manufacturer-assigned part identifier
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this item
discovered:
type: boolean
description: This item was automatically discovered
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
_depth:
type: integer
format: int32
readOnly: true
WritableInventoryItem:
title: WritableInventoryItem
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
parent:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
manufacturer:
type: integer
format: int32
part_id:
maxLength: 50
type: string
description: Manufacturer-assigned part identifier
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this item
discovered:
type: boolean
description: This item was automatically discovered
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
_depth:
type: integer
format: int32
readOnly: true
Manufacturer:
title: Manufacturer
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
description:
maxLength: 200
type: string
devicetype_count:
type: integer
format: int32
readOnly: true
inventoryitem_count:
type: integer
format: int32
readOnly: true
platform_count:
type: integer
format: int32
readOnly: true
Platform:
title: Platform
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
manufacturer:
$ref: '#/components/schemas/NestedManufacturer'
napalm_driver:
maxLength: 50
type: string
description: The name of the NAPALM driver to use when interacting with devices
napalm_args:
type: string
description: Additional arguments to pass when initiating the NAPALM driver (JSON format)
description:
maxLength: 200
type: string
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
WritablePlatform:
title: WritablePlatform
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
manufacturer:
type: integer
description: Optionally limit this platform to devices of a certain manufacturer
format: int32
napalm_driver:
maxLength: 50
type: string
description: The name of the NAPALM driver to use when interacting with devices
napalm_args:
type: string
description: Additional arguments to pass when initiating the NAPALM driver (JSON format)
description:
maxLength: 200
type: string
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
PowerPort:
title: PowerPort
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type18'
maximum_draw:
maximum: 32767
minimum: 1
type: integer
description: Maximum power draw (watts)
format: int32
allocated_draw:
maximum: 32767
minimum: 1
type: integer
description: Allocated power draw (watts)
format: int32
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
NestedPowerPanel:
title: NestedPowerPanel
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
powerfeed_count:
type: integer
format: int32
readOnly: true
PowerFeed:
title: PowerFeed
required:
- power_panel
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
power_panel:
$ref: '#/components/schemas/NestedPowerPanel'
rack:
$ref: '#/components/schemas/NestedRack'
name:
maxLength: 100
minLength: 1
type: string
status:
$ref: '#/components/schemas/Status7'
type:
$ref: '#/components/schemas/Type19'
supply:
$ref: '#/components/schemas/Supply'
phase:
$ref: '#/components/schemas/Phase'
voltage:
maximum: 32767
minimum: -32768
type: integer
format: int32
amperage:
maximum: 32767
minimum: 1
type: integer
format: int32
max_utilization:
maximum: 100
minimum: 1
type: integer
description: Maximum permissible draw (percentage)
format: int32
comments:
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritablePowerFeed:
title: WritablePowerFeed
required:
- power_panel
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
power_panel:
type: integer
format: int32
rack:
type: integer
format: int32
name:
maxLength: 100
minLength: 1
type: string
status:
$ref: '#/components/schemas/Status8'
type:
$ref: '#/components/schemas/Type20'
supply:
$ref: '#/components/schemas/Supply1'
phase:
$ref: '#/components/schemas/Phase1'
voltage:
maximum: 32767
minimum: -32768
type: integer
format: int32
amperage:
maximum: 32767
minimum: 1
type: integer
format: int32
max_utilization:
maximum: 100
minimum: 1
type: integer
description: Maximum permissible draw (percentage)
format: int32
comments:
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
NestedPowerPortTemplate:
title: NestedPowerPortTemplate
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
PowerOutletTemplate:
title: PowerOutletTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type21'
power_port:
$ref: '#/components/schemas/NestedPowerPortTemplate'
feed_leg:
$ref: '#/components/schemas/Feedleg'
description:
maxLength: 200
type: string
WritablePowerOutletTemplate:
title: WritablePowerOutletTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type22'
power_port:
type: integer
format: int32
feed_leg:
$ref: '#/components/schemas/Feedleg1'
description:
maxLength: 200
type: string
NestedPowerPort:
title: NestedPowerPort
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
cable:
type: integer
format: int32
PowerOutlet:
title: PowerOutlet
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type21'
power_port:
$ref: '#/components/schemas/NestedPowerPort'
feed_leg:
$ref: '#/components/schemas/Feedleg'
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
WritablePowerOutlet:
title: WritablePowerOutlet
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type24'
power_port:
type: integer
format: int32
feed_leg:
$ref: '#/components/schemas/Feedleg1'
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
NestedRackGroup:
title: NestedRackGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
rack_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
PowerPanel:
title: PowerPanel
required:
- site
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
site:
$ref: '#/components/schemas/NestedSite'
rack_group:
$ref: '#/components/schemas/NestedRackGroup'
name:
maxLength: 100
minLength: 1
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
powerfeed_count:
type: integer
format: int32
readOnly: true
WritablePowerPanel:
title: WritablePowerPanel
required:
- site
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
site:
type: integer
format: int32
rack_group:
type: integer
format: int32
name:
maxLength: 100
minLength: 1
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
powerfeed_count:
type: integer
format: int32
readOnly: true
PowerPortTemplate:
title: PowerPortTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type18'
maximum_draw:
maximum: 32767
minimum: 1
type: integer
description: Maximum power draw (watts)
format: int32
allocated_draw:
maximum: 32767
minimum: 1
type: integer
description: Allocated power draw (watts)
format: int32
description:
maxLength: 200
type: string
WritablePowerPortTemplate:
title: WritablePowerPortTemplate
required:
- device_type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type26'
maximum_draw:
maximum: 32767
minimum: 1
type: integer
description: Maximum power draw (watts)
format: int32
allocated_draw:
maximum: 32767
minimum: 1
type: integer
description: Allocated power draw (watts)
format: int32
description:
maxLength: 200
type: string
WritablePowerPort:
title: WritablePowerPort
required:
- device
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type27'
maximum_draw:
maximum: 32767
minimum: 1
type: integer
description: Maximum power draw (watts)
format: int32
allocated_draw:
maximum: 32767
minimum: 1
type: integer
description: Allocated power draw (watts)
format: int32
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
connected_endpoint:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the type of connected object.
readOnly: true
connected_endpoint_type:
type: string
readOnly: true
connected_endpoint_reachable:
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
RackGroup:
title: RackGroup
required:
- name
- slug
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
site:
$ref: '#/components/schemas/NestedSite'
parent:
$ref: '#/components/schemas/NestedRackGroup'
description:
maxLength: 200
type: string
rack_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
WritableRackGroup:
title: WritableRackGroup
required:
- name
- slug
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
site:
type: integer
format: int32
parent:
type: integer
format: int32
description:
maxLength: 200
type: string
rack_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
NestedUser:
title: NestedUser
required:
- username
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
username:
maxLength: 150
minLength: 1
pattern: ^[\w.@+-]+$
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
RackReservation:
title: RackReservation
required:
- rack
- units
- user
- description
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
rack:
$ref: '#/components/schemas/NestedRack'
units:
type: array
items:
maximum: 32767
minimum: 0
type: integer
format: int32
description: ''
created:
type: string
format: date
readOnly: true
user:
$ref: '#/components/schemas/NestedUser'
tenant:
$ref: '#/components/schemas/NestedTenant'
description:
maxLength: 200
minLength: 1
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
WritableRackReservation:
title: WritableRackReservation
required:
- rack
- units
- user
- description
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
rack:
type: integer
format: int32
units:
type: array
items:
maximum: 32767
minimum: 0
type: integer
format: int32
description: ''
created:
type: string
format: date
readOnly: true
user:
type: integer
format: int32
tenant:
type: integer
format: int32
description:
maxLength: 200
minLength: 1
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
RackRole:
title: RackRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
color:
maxLength: 6
minLength: 1
pattern: ^[0-9a-f]{6}$
type: string
description:
maxLength: 200
type: string
rack_count:
type: integer
format: int32
readOnly: true
NestedRackRole:
title: NestedRackRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
rack_count:
type: integer
format: int32
readOnly: true
Rack:
title: Rack
required:
- name
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
facility_id:
maxLength: 50
type: string
description: Locally-assigned identifier
display_name:
type: string
readOnly: true
site:
$ref: '#/components/schemas/NestedSite'
group:
$ref: '#/components/schemas/NestedRackGroup'
tenant:
$ref: '#/components/schemas/NestedTenant'
status:
$ref: '#/components/schemas/Status9'
role:
$ref: '#/components/schemas/NestedRackRole'
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this rack
type:
$ref: '#/components/schemas/Type28'
width:
$ref: '#/components/schemas/Width'
u_height:
maximum: 100
minimum: 1
type: integer
description: Height in rack units
format: int32
desc_units:
type: boolean
description: Units are numbered top-to-bottom
outer_width:
maximum: 32767
minimum: 0
type: integer
description: Outer dimension of rack (width)
format: int32
outer_depth:
maximum: 32767
minimum: 0
type: integer
description: Outer dimension of rack (depth)
format: int32
outer_unit:
$ref: '#/components/schemas/Outerunit'
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
powerfeed_count:
type: integer
format: int32
readOnly: true
WritableRack:
title: WritableRack
required:
- name
- site
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
facility_id:
maxLength: 50
type: string
description: Locally-assigned identifier
display_name:
type: string
readOnly: true
site:
type: integer
format: int32
group:
type: integer
description: Assigned group
format: int32
tenant:
type: integer
format: int32
status:
$ref: '#/components/schemas/Status10'
role:
type: integer
description: Functional role
format: int32
serial:
maxLength: 50
type: string
asset_tag:
maxLength: 50
type: string
description: A unique tag used to identify this rack
type:
$ref: '#/components/schemas/Type29'
width:
$ref: '#/components/schemas/Width1'
u_height:
maximum: 100
minimum: 1
type: integer
description: Height in rack units
format: int32
desc_units:
type: boolean
description: Units are numbered top-to-bottom
outer_width:
maximum: 32767
minimum: 0
type: integer
description: Outer dimension of rack (width)
format: int32
outer_depth:
maximum: 32767
minimum: 0
type: integer
description: Outer dimension of rack (depth)
format: int32
outer_unit:
$ref: '#/components/schemas/Outerunit1'
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
powerfeed_count:
type: integer
format: int32
readOnly: true
RackUnit:
title: RackUnit
type: object
properties:
id:
type: integer
format: int32
readOnly: true
name:
minLength: 1
type: string
readOnly: true
face:
allOf:
- $ref: '#/components/schemas/Face'
- {}
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
occupied:
type: boolean
readOnly: true
RearPortTemplate:
title: RearPortTemplate
required:
- device_type
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
$ref: '#/components/schemas/NestedDeviceType'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type10'
positions:
maximum: 1024
minimum: 1
type: integer
format: int32
description:
maxLength: 200
type: string
WritableRearPortTemplate:
title: WritableRearPortTemplate
required:
- device_type
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device_type:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type11'
positions:
maximum: 1024
minimum: 1
type: integer
format: int32
description:
maxLength: 200
type: string
RearPort:
title: RearPort
required:
- device
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type10'
positions:
maximum: 1024
minimum: 1
type: integer
format: int32
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
WritableRearPort:
title: WritableRearPort
required:
- device
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
label:
maxLength: 64
type: string
description: Physical label
type:
$ref: '#/components/schemas/Type11'
positions:
maximum: 1024
minimum: 1
type: integer
format: int32
description:
maxLength: 200
type: string
cable:
$ref: '#/components/schemas/NestedCable'
cable_peer:
type: object
additionalProperties:
type: string
description: Return the appropriate serializer for the cable termination model.
readOnly: true
cable_peer_type:
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
NestedRegion:
title: NestedRegion
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
site_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
Region:
title: Region
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
parent:
$ref: '#/components/schemas/NestedRegion'
description:
maxLength: 200
type: string
site_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
WritableRegion:
title: WritableRegion
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
parent:
type: integer
format: int32
description:
maxLength: 200
type: string
site_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
Site:
title: Site
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
status:
$ref: '#/components/schemas/Status11'
region:
$ref: '#/components/schemas/NestedRegion'
tenant:
$ref: '#/components/schemas/NestedTenant'
facility:
maxLength: 50
type: string
description: Local facility ID or description
asn:
maximum: 4294967295
minimum: 1
type: integer
description: 32-bit autonomous system number
format: int32
time_zone:
type: string
description:
maxLength: 200
type: string
physical_address:
maxLength: 200
type: string
shipping_address:
maxLength: 200
type: string
latitude:
type: string
description: GPS coordinate (latitude)
longitude:
type: string
description: GPS coordinate (longitude)
contact_name:
maxLength: 50
type: string
contact_phone:
maxLength: 20
type: string
contact_email:
maxLength: 254
type: string
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
circuit_count:
type: integer
format: int32
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
rack_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
vlan_count:
type: integer
format: int32
readOnly: true
WritableSite:
title: WritableSite
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
status:
$ref: '#/components/schemas/Status12'
region:
type: integer
format: int32
tenant:
type: integer
format: int32
facility:
maxLength: 50
type: string
description: Local facility ID or description
asn:
maximum: 4294967295
minimum: 1
type: integer
description: 32-bit autonomous system number
format: int32
time_zone:
type: string
description:
maxLength: 200
type: string
physical_address:
maxLength: 200
type: string
shipping_address:
maxLength: 200
type: string
latitude:
type: string
description: GPS coordinate (latitude)
longitude:
type: string
description: GPS coordinate (longitude)
contact_name:
maxLength: 50
type: string
contact_phone:
maxLength: 20
type: string
contact_email:
maxLength: 254
type: string
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
circuit_count:
type: integer
format: int32
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
rack_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
vlan_count:
type: integer
format: int32
readOnly: true
VirtualChassis:
title: VirtualChassis
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
domain:
maxLength: 30
type: string
master:
$ref: '#/components/schemas/NestedDevice'
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
member_count:
type: integer
format: int32
readOnly: true
WritableVirtualChassis:
title: WritableVirtualChassis
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
domain:
maxLength: 30
type: string
master:
type: integer
format: int32
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
member_count:
type: integer
format: int32
readOnly: true
NestedClusterGroup:
title: NestedClusterGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
cluster_count:
type: integer
format: int32
readOnly: true
NestedTenantGroup:
title: NestedTenantGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
tenant_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
ConfigContext:
title: ConfigContext
required:
- name
- data
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
weight:
maximum: 32767
minimum: 0
type: integer
format: int32
description:
maxLength: 200
type: string
is_active:
type: boolean
regions:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedRegion'
description: ''
sites:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedSite'
description: ''
roles:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedDeviceRole'
description: ''
platforms:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedPlatform'
description: ''
cluster_groups:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedClusterGroup'
description: ''
clusters:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedCluster'
description: ''
tenant_groups:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedTenantGroup'
description: ''
tenants:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedTenant'
description: ''
tags:
uniqueItems: true
type: array
items:
pattern: ^[-a-zA-Z0-9_]+$
type: string
description: ''
data:
type: string
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableConfigContext:
title: WritableConfigContext
required:
- name
- data
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
weight:
maximum: 32767
minimum: 0
type: integer
format: int32
description:
maxLength: 200
type: string
is_active:
type: boolean
regions:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
sites:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
roles:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
platforms:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
cluster_groups:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
clusters:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
tenant_groups:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
tenants:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
tags:
uniqueItems: true
type: array
items:
pattern: ^[-a-zA-Z0-9_]+$
type: string
description: ''
data:
type: string
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
ContentType:
title: ContentType
required:
- app_label
- model
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
app_label:
maxLength: 100
minLength: 1
type: string
model:
maxLength: 100
minLength: 1
type: string
display_name:
minLength: 1
type: string
readOnly: true
CustomField:
title: CustomField
required:
- content_types
- type
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
content_types:
uniqueItems: true
type: array
items:
type: string
description: ''
type:
$ref: '#/components/schemas/Type34'
name:
maxLength: 50
minLength: 1
type: string
description: Internal field name
label:
maxLength: 50
type: string
description: Name of the field as displayed to users (if not provided, the field's name will be used)
description:
maxLength: 200
type: string
required:
type: boolean
description: If true, this field is required when creating new objects or editing an existing object.
filter_logic:
$ref: '#/components/schemas/Filterlogic'
default:
type: string
description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
weight:
maximum: 32767
minimum: 0
type: integer
description: Fields with higher weights appear lower in a form.
format: int32
validation_minimum:
maximum: 2147483647
minimum: 0
type: integer
description: Minimum allowed value (for numeric fields)
format: int32
validation_maximum:
maximum: 2147483647
minimum: 0
type: integer
description: Maximum allowed value (for numeric fields)
format: int32
validation_regex:
maxLength: 500
type: string
description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters.
choices:
type: array
items:
maxLength: 100
minLength: 1
type: string
description: Comma-separated list of available choices (for selection fields)
WritableCustomField:
title: WritableCustomField
required:
- content_types
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
content_types:
uniqueItems: true
type: array
items:
type: string
description: ''
type:
$ref: '#/components/schemas/Type35'
name:
maxLength: 50
minLength: 1
type: string
description: Internal field name
label:
maxLength: 50
type: string
description: Name of the field as displayed to users (if not provided, the field's name will be used)
description:
maxLength: 200
type: string
required:
type: boolean
description: If true, this field is required when creating new objects or editing an existing object.
filter_logic:
$ref: '#/components/schemas/Filterlogic1'
default:
type: string
description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
weight:
maximum: 32767
minimum: 0
type: integer
description: Fields with higher weights appear lower in a form.
format: int32
validation_minimum:
maximum: 2147483647
minimum: 0
type: integer
description: Minimum allowed value (for numeric fields)
format: int32
validation_maximum:
maximum: 2147483647
minimum: 0
type: integer
description: Maximum allowed value (for numeric fields)
format: int32
validation_regex:
maxLength: 500
type: string
description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters.
choices:
type: array
items:
maxLength: 100
minLength: 1
type: string
description: Comma-separated list of available choices (for selection fields)
ExportTemplate:
title: ExportTemplate
required:
- content_type
- name
- template_code
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
content_type:
type: string
name:
maxLength: 100
minLength: 1
type: string
description:
maxLength: 200
type: string
template_code:
minLength: 1
type: string
description: The list of objects being exported is passed as a context variable named <code>queryset</code>.
mime_type:
maxLength: 50
type: string
description: Defaults to <code>text/plain</code>
file_extension:
maxLength: 15
type: string
description: Extension to append to the rendered filename
ImageAttachment:
title: ImageAttachment
required:
- content_type
- object_id
- image_height
- image_width
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
content_type:
type: string
object_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
parent:
type: object
additionalProperties:
type: string
readOnly: true
name:
maxLength: 50
type: string
image:
type: string
readOnly: true
image_height:
maximum: 32767
minimum: 0
type: integer
format: int32
image_width:
maximum: 32767
minimum: 0
type: integer
format: int32
created:
type: string
format: date-time
readOnly: true
JobResult:
title: JobResult
required:
- name
- job_id
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
completed:
type: string
format: date-time
name:
maxLength: 255
minLength: 1
type: string
obj_type:
type: string
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/Status13'
- {}
readOnly: true
user:
$ref: '#/components/schemas/NestedUser'
data:
type: string
job_id:
type: string
format: uuid
ObjectChange:
title: ObjectChange
required:
- changed_object_id
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
time:
type: string
format: date-time
readOnly: true
user:
$ref: '#/components/schemas/NestedUser'
user_name:
minLength: 1
type: string
readOnly: true
request_id:
type: string
format: uuid
readOnly: true
action:
allOf:
- $ref: '#/components/schemas/Action'
- {}
readOnly: true
changed_object_type:
type: string
readOnly: true
changed_object_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
changed_object:
type: object
additionalProperties:
type: string
description: Serialize a nested representation of the changed object.
readOnly: true
object_data:
type: string
readOnly: true
Tag:
title: Tag
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
color:
maxLength: 6
minLength: 1
pattern: ^[0-9a-f]{6}$
type: string
description:
maxLength: 200
type: string
tagged_items:
type: integer
format: int32
readOnly: true
NestedRIR:
title: NestedRIR
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
aggregate_count:
type: integer
format: int32
readOnly: true
Aggregate:
title: Aggregate
required:
- prefix
- rir
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
allOf:
- $ref: '#/components/schemas/Family'
- {}
readOnly: true
prefix:
type: string
rir:
$ref: '#/components/schemas/NestedRIR'
tenant:
$ref: '#/components/schemas/NestedTenant'
date_added:
type: string
format: date
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableAggregate:
title: WritableAggregate
required:
- prefix
- rir
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
type: string
readOnly: true
prefix:
type: string
rir:
type: integer
format: int32
tenant:
type: integer
format: int32
date_added:
type: string
format: date
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
NestedVRF:
title: NestedVRF
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
rd:
maxLength: 21
type: string
description: Unique route distinguisher (as defined in RFC 4364)
display_name:
type: string
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
IPAddress:
title: IPAddress
required:
- address
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
allOf:
- $ref: '#/components/schemas/Family'
- {}
readOnly: true
address:
type: string
description: IPv4 or IPv6 address (with mask)
vrf:
$ref: '#/components/schemas/NestedVRF'
tenant:
$ref: '#/components/schemas/NestedTenant'
status:
$ref: '#/components/schemas/Status14'
role:
$ref: '#/components/schemas/Role3'
assigned_object_type:
type: string
assigned_object_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
assigned_object:
type: object
additionalProperties:
type: string
readOnly: true
nat_inside:
$ref: '#/components/schemas/NestedIPAddress'
nat_outside:
$ref: '#/components/schemas/NestedIPAddress'
dns_name:
maxLength: 255
pattern: ^[0-9A-Za-z._-]+$
type: string
description: Hostname or FQDN (not case-sensitive)
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableIPAddress:
title: WritableIPAddress
required:
- address
- nat_outside
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
type: string
readOnly: true
address:
type: string
description: IPv4 or IPv6 address (with mask)
vrf:
type: integer
format: int32
tenant:
type: integer
format: int32
status:
$ref: '#/components/schemas/Status15'
role:
$ref: '#/components/schemas/Role1'
assigned_object_type:
type: string
assigned_object_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
assigned_object:
type: object
additionalProperties:
type: string
readOnly: true
nat_inside:
type: integer
description: The IP for which this address is the "outside" IP
format: int32
nat_outside:
type: integer
format: int32
dns_name:
maxLength: 255
pattern: ^[0-9A-Za-z._-]+$
type: string
description: Hostname or FQDN (not case-sensitive)
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
NestedRole:
title: NestedRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
prefix_count:
type: integer
format: int32
readOnly: true
vlan_count:
type: integer
format: int32
readOnly: true
Prefix:
title: Prefix
required:
- prefix
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
allOf:
- $ref: '#/components/schemas/Family'
- {}
readOnly: true
prefix:
type: string
description: IPv4 or IPv6 network with mask
site:
$ref: '#/components/schemas/NestedSite'
vrf:
$ref: '#/components/schemas/NestedVRF'
tenant:
$ref: '#/components/schemas/NestedTenant'
vlan:
$ref: '#/components/schemas/NestedVLAN'
status:
$ref: '#/components/schemas/Status16'
role:
$ref: '#/components/schemas/NestedRole'
is_pool:
type: boolean
description: All IP addresses within this prefix are considered usable
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritablePrefix:
title: WritablePrefix
required:
- prefix
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
family:
type: string
readOnly: true
prefix:
type: string
description: IPv4 or IPv6 network with mask
site:
type: integer
format: int32
vrf:
type: integer
format: int32
tenant:
type: integer
format: int32
vlan:
type: integer
format: int32
status:
$ref: '#/components/schemas/Status17'
role:
type: integer
description: The primary function of this prefix
format: int32
is_pool:
type: boolean
description: All IP addresses within this prefix are considered usable
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
AvailableIP:
title: AvailableIP
type: object
properties:
family:
type: integer
format: int32
readOnly: true
address:
minLength: 1
type: string
readOnly: true
vrf:
$ref: '#/components/schemas/NestedVRF'
AvailablePrefix:
title: AvailablePrefix
type: object
properties:
family:
type: integer
format: int32
readOnly: true
prefix:
minLength: 1
type: string
readOnly: true
vrf:
$ref: '#/components/schemas/NestedVRF'
PrefixLength:
title: PrefixLength
required:
- prefix_length
type: object
properties:
prefix_length:
type: integer
format: int32
RIR:
title: RIR
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
is_private:
type: boolean
description: IP space managed by this RIR is considered private
description:
maxLength: 200
type: string
aggregate_count:
type: integer
format: int32
readOnly: true
Role:
title: Role
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
weight:
maximum: 32767
minimum: 0
type: integer
format: int32
description:
maxLength: 200
type: string
prefix_count:
type: integer
format: int32
readOnly: true
vlan_count:
type: integer
format: int32
readOnly: true
RouteTarget:
title: RouteTarget
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 21
minLength: 1
type: string
description: Route target value (formatted in accordance with RFC 4360)
tenant:
$ref: '#/components/schemas/NestedTenant'
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableRouteTarget:
title: WritableRouteTarget
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 21
minLength: 1
type: string
description: Route target value (formatted in accordance with RFC 4360)
tenant:
type: integer
format: int32
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
NestedVirtualMachine:
title: NestedVirtualMachine
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
Service:
title: Service
required:
- name
- ports
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
$ref: '#/components/schemas/NestedDevice'
virtual_machine:
$ref: '#/components/schemas/NestedVirtualMachine'
name:
maxLength: 100
minLength: 1
type: string
ports:
type: array
items:
maximum: 65535
minimum: 1
type: integer
format: int32
description: ''
protocol:
$ref: '#/components/schemas/Protocol'
ipaddresses:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedIPAddress'
description: ''
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableService:
title: WritableService
required:
- name
- ports
- protocol
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
device:
type: integer
format: int32
virtual_machine:
type: integer
format: int32
name:
maxLength: 100
minLength: 1
type: string
ports:
type: array
items:
maximum: 65535
minimum: 1
type: integer
format: int32
description: ''
protocol:
$ref: '#/components/schemas/Protocol1'
ipaddresses:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
VLANGroup:
title: VLANGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
site:
$ref: '#/components/schemas/NestedSite'
description:
maxLength: 200
type: string
vlan_count:
type: integer
format: int32
readOnly: true
WritableVLANGroup:
title: WritableVLANGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
site:
type: integer
format: int32
description:
maxLength: 200
type: string
vlan_count:
type: integer
format: int32
readOnly: true
NestedVLANGroup:
title: NestedVLANGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
vlan_count:
type: integer
format: int32
readOnly: true
VLAN:
title: VLAN
required:
- vid
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
site:
$ref: '#/components/schemas/NestedSite'
group:
$ref: '#/components/schemas/NestedVLANGroup'
vid:
maximum: 4094
minimum: 1
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
tenant:
$ref: '#/components/schemas/NestedTenant'
status:
$ref: '#/components/schemas/Status18'
role:
$ref: '#/components/schemas/NestedRole'
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
display_name:
type: string
readOnly: true
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
WritableVLAN:
title: WritableVLAN
required:
- vid
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
site:
type: integer
format: int32
group:
type: integer
format: int32
vid:
maximum: 4094
minimum: 1
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
tenant:
type: integer
format: int32
status:
$ref: '#/components/schemas/Status19'
role:
type: integer
format: int32
description:
maxLength: 200
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
display_name:
type: string
readOnly: true
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
NestedRouteTarget:
title: NestedRouteTarget
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 21
minLength: 1
type: string
description: Route target value (formatted in accordance with RFC 4360)
VRF:
title: VRF
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
rd:
maxLength: 21
type: string
description: Unique route distinguisher (as defined in RFC 4364)
tenant:
$ref: '#/components/schemas/NestedTenant'
enforce_unique:
type: boolean
description: Prevent duplicate prefixes/IP addresses within this VRF
description:
maxLength: 200
type: string
import_targets:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedRouteTarget'
description: ''
export_targets:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedRouteTarget'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
display_name:
type: string
readOnly: true
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
ipaddress_count:
type: integer
format: int32
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
WritableVRF:
title: WritableVRF
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
rd:
maxLength: 21
type: string
description: Unique route distinguisher (as defined in RFC 4364)
tenant:
type: integer
format: int32
enforce_unique:
type: boolean
description: Prevent duplicate prefixes/IP addresses within this VRF
description:
maxLength: 200
type: string
import_targets:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
export_targets:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
display_name:
type: string
readOnly: true
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
ipaddress_count:
type: integer
format: int32
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
SecretRole:
title: SecretRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
description:
maxLength: 200
type: string
secret_count:
type: integer
format: int32
readOnly: true
NestedSecretRole:
title: NestedSecretRole
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
secret_count:
type: integer
format: int32
readOnly: true
Secret:
title: Secret
required:
- assigned_object_type
- assigned_object_id
- role
- plaintext
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
assigned_object_type:
type: string
assigned_object_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
assigned_object:
type: object
additionalProperties:
type: string
readOnly: true
role:
$ref: '#/components/schemas/NestedSecretRole'
name:
maxLength: 100
type: string
plaintext:
minLength: 1
type: string
hash:
minLength: 1
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableSecret:
title: WritableSecret
required:
- assigned_object_type
- assigned_object_id
- role
- plaintext
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
assigned_object_type:
type: string
assigned_object_id:
maximum: 2147483647
minimum: 0
type: integer
format: int32
assigned_object:
type: object
additionalProperties:
type: string
readOnly: true
role:
type: integer
format: int32
name:
maxLength: 100
type: string
plaintext:
minLength: 1
type: string
hash:
minLength: 1
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
TenantGroup:
title: TenantGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
parent:
$ref: '#/components/schemas/NestedTenantGroup'
description:
maxLength: 200
type: string
tenant_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
WritableTenantGroup:
title: WritableTenantGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
parent:
type: integer
format: int32
description:
maxLength: 200
type: string
tenant_count:
type: integer
format: int32
readOnly: true
_depth:
type: integer
format: int32
readOnly: true
Tenant:
title: Tenant
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
group:
$ref: '#/components/schemas/NestedTenantGroup'
description:
maxLength: 200
type: string
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
circuit_count:
type: integer
format: int32
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
ipaddress_count:
type: integer
format: int32
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
rack_count:
type: integer
format: int32
readOnly: true
site_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
vlan_count:
type: integer
format: int32
readOnly: true
vrf_count:
type: integer
format: int32
readOnly: true
cluster_count:
type: integer
format: int32
readOnly: true
WritableTenant:
title: WritableTenant
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
group:
type: integer
format: int32
description:
maxLength: 200
type: string
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
circuit_count:
type: integer
format: int32
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
ipaddress_count:
type: integer
format: int32
readOnly: true
prefix_count:
type: integer
format: int32
readOnly: true
rack_count:
type: integer
format: int32
readOnly: true
site_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
vlan_count:
type: integer
format: int32
readOnly: true
vrf_count:
type: integer
format: int32
readOnly: true
cluster_count:
type: integer
format: int32
readOnly: true
Group:
title: Group
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 150
minLength: 1
type: string
user_count:
type: integer
format: int32
readOnly: true
NestedGroup:
title: NestedGroup
required:
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 150
minLength: 1
type: string
ObjectPermission:
title: ObjectPermission
required:
- name
- object_types
- actions
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
description:
maxLength: 200
type: string
enabled:
type: boolean
object_types:
uniqueItems: true
type: array
items:
type: string
description: ''
groups:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedGroup'
description: ''
users:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedUser'
description: ''
actions:
type: array
items:
maxLength: 30
minLength: 1
type: string
description: The list of actions granted by this permission
constraints:
type: string
description: Queryset filter matching the applicable objects of the selected type(s)
WritableObjectPermission:
title: WritableObjectPermission
required:
- name
- object_types
- actions
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
description:
maxLength: 200
type: string
enabled:
type: boolean
object_types:
uniqueItems: true
type: array
items:
type: string
description: ''
groups:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
users:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
actions:
type: array
items:
maxLength: 30
minLength: 1
type: string
description: The list of actions granted by this permission
constraints:
type: string
description: Queryset filter matching the applicable objects of the selected type(s)
User:
title: User
required:
- username
- password
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
username:
maxLength: 150
minLength: 1
pattern: ^[\w.@+-]+$
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password:
maxLength: 128
minLength: 1
type: string
first_name:
maxLength: 150
type: string
last_name:
maxLength: 150
type: string
email:
maxLength: 254
type: string
is_staff:
type: boolean
description: Designates whether the user can log into this admin site.
is_active:
type: boolean
description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined:
type: string
format: date-time
groups:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedGroup'
description: ''
WritableUser:
title: WritableUser
required:
- username
- password
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
username:
maxLength: 150
minLength: 1
pattern: ^[\w.@+-]+$
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password:
maxLength: 128
minLength: 1
type: string
first_name:
maxLength: 150
type: string
last_name:
maxLength: 150
type: string
email:
maxLength: 254
type: string
is_staff:
type: boolean
description: Designates whether the user can log into this admin site.
is_active:
type: boolean
description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined:
type: string
format: date-time
groups:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: The groups this user belongs to. A user will get all permissions granted to each of their groups.
ClusterGroup:
title: ClusterGroup
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
description:
maxLength: 200
type: string
cluster_count:
type: integer
format: int32
readOnly: true
ClusterType:
title: ClusterType
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
description:
maxLength: 200
type: string
cluster_count:
type: integer
format: int32
readOnly: true
NestedClusterType:
title: NestedClusterType
required:
- name
- slug
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
slug:
maxLength: 100
minLength: 1
pattern: ^[-a-zA-Z0-9_]+$
type: string
cluster_count:
type: integer
format: int32
readOnly: true
Cluster:
title: Cluster
required:
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
type:
$ref: '#/components/schemas/NestedClusterType'
group:
$ref: '#/components/schemas/NestedClusterGroup'
tenant:
$ref: '#/components/schemas/NestedTenant'
site:
$ref: '#/components/schemas/NestedSite'
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
WritableCluster:
title: WritableCluster
required:
- name
- type
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 100
minLength: 1
type: string
type:
type: integer
format: int32
group:
type: integer
format: int32
tenant:
type: integer
format: int32
site:
type: integer
format: int32
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
device_count:
type: integer
format: int32
readOnly: true
virtualmachine_count:
type: integer
format: int32
readOnly: true
VMInterface:
title: VMInterface
required:
- virtual_machine
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
virtual_machine:
$ref: '#/components/schemas/NestedVirtualMachine'
name:
maxLength: 64
minLength: 1
type: string
enabled:
type: boolean
mtu:
maximum: 65536
minimum: 1
type: integer
format: int32
mac_address:
type: string
description:
maxLength: 200
type: string
mode:
$ref: '#/components/schemas/Mode'
untagged_vlan:
$ref: '#/components/schemas/NestedVLAN'
tagged_vlans:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NestedVLAN'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
WritableVMInterface:
title: WritableVMInterface
required:
- virtual_machine
- name
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
virtual_machine:
type: integer
format: int32
name:
maxLength: 64
minLength: 1
type: string
enabled:
type: boolean
mtu:
maximum: 65536
minimum: 1
type: integer
format: int32
mac_address:
type: string
description:
maxLength: 200
type: string
mode:
$ref: '#/components/schemas/Mode1'
untagged_vlan:
type: integer
format: int32
tagged_vlans:
uniqueItems: true
type: array
items:
type: integer
format: int32
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
VirtualMachineWithConfigContext:
title: VirtualMachineWithConfigContext
required:
- name
- cluster
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
status:
$ref: '#/components/schemas/Status20'
site:
$ref: '#/components/schemas/NestedSite'
cluster:
$ref: '#/components/schemas/NestedCluster'
role:
$ref: '#/components/schemas/NestedDeviceRole'
tenant:
$ref: '#/components/schemas/NestedTenant'
platform:
$ref: '#/components/schemas/NestedPlatform'
primary_ip:
$ref: '#/components/schemas/NestedIPAddress'
primary_ip4:
$ref: '#/components/schemas/NestedIPAddress'
primary_ip6:
$ref: '#/components/schemas/NestedIPAddress'
vcpus:
maximum: 32767
minimum: 0
type: integer
format: int32
memory:
maximum: 2147483647
minimum: 0
type: integer
format: int32
disk:
maximum: 2147483647
minimum: 0
type: integer
format: int32
comments:
type: string
local_context_data:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
config_context:
type: object
additionalProperties:
type: string
readOnly: true
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
WritableVirtualMachineWithConfigContext:
title: WritableVirtualMachineWithConfigContext
required:
- name
- cluster
type: object
properties:
id:
type: integer
format: int32
readOnly: true
url:
type: string
readOnly: true
name:
maxLength: 64
minLength: 1
type: string
status:
$ref: '#/components/schemas/Status21'
site:
type: string
readOnly: true
cluster:
type: integer
format: int32
role:
type: integer
format: int32
tenant:
type: integer
format: int32
platform:
type: integer
format: int32
primary_ip:
type: string
readOnly: true
primary_ip4:
type: integer
format: int32
primary_ip6:
type: integer
format: int32
vcpus:
maximum: 32767
minimum: 0
type: integer
format: int32
memory:
maximum: 2147483647
minimum: 0
type: integer
format: int32
disk:
maximum: 2147483647
minimum: 0
type: integer
format: int32
comments:
type: string
local_context_data:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
description: ''
custom_fields:
type: object
config_context:
type: object
additionalProperties:
type: string
readOnly: true
created:
type: string
format: date
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
Action:
title: Action
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label38'
value:
$ref: '#/components/schemas/Value38'
circuits_circuits_listResponse:
title: circuits_circuits_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Circuit'
description: ''
circuits_circuit-terminations_listResponse:
title: circuits_circuit-terminations_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/CircuitTermination'
description: ''
circuits_circuit-types_listResponse:
title: circuits_circuit-types_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/CircuitType'
description: ''
circuits_providers_listResponse:
title: circuits_providers_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Provider'
description: ''
dcim_cables_listResponse:
title: dcim_cables_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Cable'
description: ''
dcim_console-connections_listResponse:
title: dcim_console-connections_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ConsolePort'
description: ''
dcim_console-ports_listResponse:
title: dcim_console-ports_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ConsolePort'
description: ''
dcim_console-port-templates_listResponse:
title: dcim_console-port-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ConsolePortTemplate'
description: ''
dcim_console-server-ports_listResponse:
title: dcim_console-server-ports_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ConsoleServerPort'
description: ''
dcim_console-server-port-templates_listResponse:
title: dcim_console-server-port-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ConsoleServerPortTemplate'
description: ''
dcim_device-bays_listResponse:
title: dcim_device-bays_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/DeviceBay'
description: ''
dcim_device-bay-templates_listResponse:
title: dcim_device-bay-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/DeviceBayTemplate'
description: ''
dcim_device-roles_listResponse:
title: dcim_device-roles_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/DeviceRole'
description: ''
dcim_devices_listResponse:
title: dcim_devices_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/DeviceWithConfigContext'
description: ''
dcim_device-types_listResponse:
title: dcim_device-types_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/DeviceType'
description: ''
dcim_front-ports_listResponse:
title: dcim_front-ports_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/FrontPort'
description: ''
dcim_front-port-templates_listResponse:
title: dcim_front-port-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/FrontPortTemplate'
description: ''
dcim_interface-connections_listResponse:
title: dcim_interface-connections_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/InterfaceConnection'
description: ''
dcim_interfaces_listResponse:
title: dcim_interfaces_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Interface'
description: ''
dcim_interface-templates_listResponse:
title: dcim_interface-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/InterfaceTemplate'
description: ''
dcim_inventory-items_listResponse:
title: dcim_inventory-items_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/InventoryItem'
description: ''
dcim_manufacturers_listResponse:
title: dcim_manufacturers_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Manufacturer'
description: ''
dcim_platforms_listResponse:
title: dcim_platforms_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Platform'
description: ''
dcim_power-connections_listResponse:
title: dcim_power-connections_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerPort'
description: ''
dcim_power-feeds_listResponse:
title: dcim_power-feeds_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerFeed'
description: ''
dcim_power-outlets_listResponse:
title: dcim_power-outlets_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerOutlet'
description: ''
dcim_power-outlet-templates_listResponse:
title: dcim_power-outlet-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerOutletTemplate'
description: ''
dcim_power-panels_listResponse:
title: dcim_power-panels_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerPanel'
description: ''
dcim_power-ports_listResponse:
title: dcim_power-ports_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerPort'
description: ''
dcim_power-port-templates_listResponse:
title: dcim_power-port-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/PowerPortTemplate'
description: ''
dcim_rack-groups_listResponse:
title: dcim_rack-groups_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RackGroup'
description: ''
dcim_rack-reservations_listResponse:
title: dcim_rack-reservations_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RackReservation'
description: ''
dcim_rack-roles_listResponse:
title: dcim_rack-roles_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RackRole'
description: ''
dcim_racks_listResponse:
title: dcim_racks_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Rack'
description: ''
dcim_rear-ports_listResponse:
title: dcim_rear-ports_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RearPort'
description: ''
dcim_rear-port-templates_listResponse:
title: dcim_rear-port-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RearPortTemplate'
description: ''
dcim_regions_listResponse:
title: dcim_regions_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Region'
description: ''
dcim_sites_listResponse:
title: dcim_sites_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Site'
description: ''
dcim_virtual-chassis_listResponse:
title: dcim_virtual-chassis_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/VirtualChassis'
description: ''
extras_config-contexts_listResponse:
title: extras_config-contexts_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ConfigContext'
description: ''
extras_content-types_listResponse:
title: extras_content-types_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ContentType'
description: ''
extras_custom-fields_listResponse:
title: extras_custom-fields_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/CustomField'
description: ''
extras_export-templates_listResponse:
title: extras_export-templates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ExportTemplate'
description: ''
extras_image-attachments_listResponse:
title: extras_image-attachments_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ImageAttachment'
description: ''
extras_job-results_listResponse:
title: extras_job-results_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/JobResult'
description: ''
extras_object-changes_listResponse:
title: extras_object-changes_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ObjectChange'
description: ''
extras_tags_listResponse:
title: extras_tags_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
Face:
title: Face
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label3'
value:
$ref: '#/components/schemas/Value3'
face3:
title: face3
enum:
- front
- rear
type: string
Family:
title: Family
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label39'
value:
$ref: '#/components/schemas/Value39'
Feedleg:
title: Feedleg
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label23'
value:
$ref: '#/components/schemas/Value23'
Feedleg1:
title: Feedleg1
enum:
- A
- B
- C
type: string
description: Phase (for three-phase feeds)
Filterlogic:
title: Filterlogic
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label36'
value:
$ref: '#/components/schemas/Value36'
Filterlogic1:
title: Filterlogic1
enum:
- disabled
- loose
- exact
type: string
description: Loose matches any instance of a given string; exact matches the entire field.
ipam_aggregates_listResponse:
title: ipam_aggregates_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Aggregate'
description: ''
ipam_ip-addresses_listResponse:
title: ipam_ip-addresses_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/IPAddress'
description: ''
ipam_prefixes_listResponse:
title: ipam_prefixes_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Prefix'
description: ''
ipam_rirs_listResponse:
title: ipam_rirs_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RIR'
description: ''
ipam_roles_listResponse:
title: ipam_roles_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Role'
description: ''
ipam_route-targets_listResponse:
title: ipam_route-targets_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/RouteTarget'
description: ''
ipam_services_listResponse:
title: ipam_services_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Service'
description: ''
ipam_vlan-groups_listResponse:
title: ipam_vlan-groups_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/VLANGroup'
description: ''
ipam_vlans_listResponse:
title: ipam_vlans_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/VLAN'
description: ''
ipam_vrfs_listResponse:
title: ipam_vrfs_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/VRF'
description: ''
Label:
title: Label
enum:
- Planned
- Provisioning
- Active
- Offline
- Deprovisioning
- Decommissioned
type: string
Label1:
title: Label1
enum:
- Connected
- Planned
- Decommissioning
type: string
Label2:
title: Label2
enum:
- Meters
- Centimeters
- Feet
- Inches
type: string
Label3:
title: Label3
enum:
- Front
- Rear
type: string
Label4:
title: Label4
enum:
- Offline
- Active
- Planned
- Staged
- Failed
- Inventory
- Decommissioning
type: string
Label5:
title: Label5
enum:
- DE-9
- DB-25
- RJ-11
- RJ-12
- RJ-45
- USB Type A
- USB Type B
- USB Type C
- USB Mini A
- USB Mini B
- USB Micro A
- USB Micro B
- Other
type: string
Label9:
title: Label9
enum:
- Parent
- Child
type: string
Label12:
title: Label12
enum:
- 8P8C
- 8P6C
- 8P4C
- 8P2C
- GG45
- TERA 4P
- TERA 2P
- TERA 1P
- 110 Punch
- BNC
- MRJ21
- FC
- LC
- LC/APC
- LSH
- LSH/APC
- MPO
- MTRJ
- SC
- SC/APC
- ST
- CS
- SN
- Splice
type: string
Label14:
title: Label14
enum:
- Virtual
- Link Aggregation Group (LAG)
- 100BASE-TX (10/100ME)
- 1000BASE-T (1GE)
- 2.5GBASE-T (2.5GE)
- 5GBASE-T (5GE)
- 10GBASE-T (10GE)
- 10GBASE-CX4 (10GE)
- GBIC (1GE)
- SFP (1GE)
- SFP+ (10GE)
- XFP (10GE)
- XENPAK (10GE)
- X2 (10GE)
- SFP28 (25GE)
- QSFP+ (40GE)
- QSFP28 (50GE)
- CFP (100GE)
- CFP2 (100GE)
- CFP2 (200GE)
- CFP4 (100GE)
- Cisco CPAK (100GE)
- QSFP28 (100GE)
- QSFP56 (200GE)
- QSFP-DD (400GE)
- OSFP (400GE)
- IEEE 802.11a
- IEEE 802.11b/g
- IEEE 802.11n
- IEEE 802.11ac
- IEEE 802.11ad
- IEEE 802.11ax
- GSM
- CDMA
- LTE
- OC-3/STM-1
- OC-12/STM-4
- OC-48/STM-16
- OC-192/STM-64
- OC-768/STM-256
- OC-1920/STM-640
- OC-3840/STM-1234
- SFP (1GFC)
- SFP (2GFC)
- SFP (4GFC)
- SFP+ (8GFC)
- SFP+ (16GFC)
- SFP28 (32GFC)
- QSFP28 (128GFC)
- SDR (2 Gbps)
- DDR (4 Gbps)
- QDR (8 Gbps)
- FDR10 (10 Gbps)
- FDR (13.5 Gbps)
- EDR (25 Gbps)
- HDR (50 Gbps)
- NDR (100 Gbps)
- XDR (250 Gbps)
- T1 (1.544 Mbps)
- E1 (2.048 Mbps)
- T3 (45 Mbps)
- E3 (34 Mbps)
- Cisco StackWise
- Cisco StackWise Plus
- Cisco FlexStack
- Cisco FlexStack Plus
- Juniper VCP
- Extreme SummitStack
- Extreme SummitStack-128
- Extreme SummitStack-256
- Extreme SummitStack-512
- Other
type: string
Label16:
title: Label16
enum:
- Access
- Tagged
- Tagged (All)
type: string
Label17:
title: Label17
enum:
- C6
- C8
- C14
- C16
- C20
- P+N+E 4H
- P+N+E 6H
- P+N+E 9H
- 2P+E 4H
- 2P+E 6H
- 2P+E 9H
- 3P+E 4H
- 3P+E 6H
- 3P+E 9H
- 3P+N+E 4H
- 3P+N+E 6H
- 3P+N+E 9H
- NEMA 1-15P
- NEMA 5-15P
- NEMA 5-20P
- NEMA 5-30P
- NEMA 5-50P
- NEMA 6-15P
- NEMA 6-20P
- NEMA 6-30P
- NEMA 6-50P
- NEMA 10-30P
- NEMA 10-50P
- NEMA 14-20P
- NEMA 14-30P
- NEMA 14-50P
- NEMA 14-60P
- NEMA 15-15P
- NEMA 15-20P
- NEMA 15-30P
- NEMA 15-50P
- NEMA 15-60P
- NEMA L1-15P
- NEMA L5-15P
- NEMA L5-20P
- NEMA L5-30P
- NEMA L5-50P
- NEMA L6-15P
- NEMA L6-20P
- NEMA L6-30P
- NEMA L6-50P
- NEMA L10-30P
- NEMA L14-20P
- NEMA L14-30P
- NEMA L14-50P
- NEMA L14-60P
- NEMA L15-20P
- NEMA L15-30P
- NEMA L15-50P
- NEMA L15-60P
- NEMA L21-20P
- NEMA L21-30P
- CS6361C
- CS6365C
- CS8165C
- CS8265C
- CS8365C
- CS8465C
- ITA Type E (CEE 7/5)
- ITA Type F (CEE 7/4)
- ITA Type E/F (CEE 7/7)
- ITA Type G (BS 1363)
- ITA Type H
- ITA Type I
- ITA Type J
- ITA Type K
- ITA Type L (CEI 23-50)
- ITA Type M (BS 546)
- ITA Type N
- ITA Type O
- USB Type A
- USB Type B
- USB Type C
- USB Mini A
- USB Mini B
- USB Micro A
- USB Micro B
- USB 3.0 Type B
- USB 3.0 Micro B
type: string
Label18:
title: Label18
enum:
- Offline
- Active
- Planned
- Failed
type: string
Label19:
title: Label19
enum:
- Primary
- Redundant
type: string
Label20:
title: Label20
enum:
- AC
- DC
type: string
Label21:
title: Label21
enum:
- Single phase
- Three-phase
type: string
Label22:
title: Label22
enum:
- C5
- C7
- C13
- C15
- C19
- P+N+E 4H
- P+N+E 6H
- P+N+E 9H
- 2P+E 4H
- 2P+E 6H
- 2P+E 9H
- 3P+E 4H
- 3P+E 6H
- 3P+E 9H
- 3P+N+E 4H
- 3P+N+E 6H
- 3P+N+E 9H
- NEMA 1-15R
- NEMA 5-15R
- NEMA 5-20R
- NEMA 5-30R
- NEMA 5-50R
- NEMA 6-15R
- NEMA 6-20R
- NEMA 6-30R
- NEMA 6-50R
- NEMA 10-30R
- NEMA 10-50R
- NEMA 14-20R
- NEMA 14-30R
- NEMA 14-50R
- NEMA 14-60R
- NEMA 15-15R
- NEMA 15-20R
- NEMA 15-30R
- NEMA 15-50R
- NEMA 15-60R
- NEMA L1-15R
- NEMA L5-15R
- NEMA L5-20R
- NEMA L5-30R
- NEMA L5-50R
- NEMA L6-15R
- NEMA L6-20R
- NEMA L6-30R
- NEMA L6-50R
- NEMA L10-30R
- NEMA L14-20R
- NEMA L14-30R
- NEMA L14-50R
- NEMA L14-60R
- NEMA L15-20R
- NEMA L15-30R
- NEMA L15-50R
- NEMA L15-60R
- NEMA L21-20R
- NEMA L21-30R
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ITA Type E (CEE7/5)
- ITA Type F (CEE7/3)
- ITA Type G (BS 1363)
- ITA Type H
- ITA Type I
- ITA Type J
- ITA Type K
- ITA Type L (CEI 23-50)
- ITA Type M (BS 546)
- ITA Type N
- ITA Type O
- USB Type A
- USB Micro B
- USB Type C
- HDOT Cx
type: string
Label23:
title: Label23
enum:
- A
- B
- C
type: string
Label27:
title: Label27
enum:
- Reserved
- Available
- Planned
- Active
- Deprecated
type: string
Label28:
title: Label28
enum:
- 2-post frame
- 4-post frame
- 4-post cabinet
- Wall-mounted frame
- Wall-mounted cabinet
type: string
Label29:
title: Label29
enum:
- 10 inches
- 19 inches
- 21 inches
- 23 inches
type: string
Label30:
title: Label30
enum:
- Millimeters
- Inches
type: string
Label34:
title: Label34
enum:
- Planned
- Staging
- Active
- Decommissioning
- Retired
type: string
Label35:
title: Label35
enum:
- Text
- Integer
- Boolean (true/false)
- Date
- URL
- Selection
type: string
Label36:
title: Label36
enum:
- Disabled
- Loose
- Exact
type: string
Label37:
title: Label37
enum:
- Pending
- Running
- Completed
- Errored
- Failed
type: string
Label38:
title: Label38
enum:
- Created
- Updated
- Deleted
type: string
Label39:
title: Label39
enum:
- IPv4
- IPv6
type: string
Label41:
title: Label41
enum:
- Active
- Reserved
- Deprecated
- DHCP
- SLAAC
type: string
Label42:
title: Label42
enum:
- Loopback
- Secondary
- Anycast
- VIP
- VRRP
- HSRP
- GLBP
- CARP
type: string
Label44:
title: Label44
enum:
- Container
- Active
- Reserved
- Deprecated
type: string
Label45:
title: Label45
enum:
- TCP
- UDP
type: string
Label46:
title: Label46
enum:
- Active
- Reserved
- Deprecated
type: string
Label48:
title: Label48
enum:
- Offline
- Active
- Planned
- Staged
- Failed
- Decommissioning
type: string
Lengthunit:
title: Lengthunit
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label2'
value:
$ref: '#/components/schemas/Value2'
Lengthunit1:
title: Lengthunit1
enum:
- m
- cm
- ft
- in
type: string
Mode:
title: Mode
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label16'
value:
$ref: '#/components/schemas/Value16'
Mode1:
title: Mode1
enum:
- access
- tagged
- tagged-all
type: string
Outerunit:
title: Outerunit
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label30'
value:
$ref: '#/components/schemas/Value30'
Outerunit1:
title: Outerunit1
enum:
- mm
- in
type: string
Parentchildstatus:
title: Parentchildstatus
enum:
- parent
- child
type: string
description: Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.
Phase:
title: Phase
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label21'
value:
$ref: '#/components/schemas/Value21'
Phase1:
title: Phase1
enum:
- single-phase
- three-phase
type: string
Protocol:
title: Protocol
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label45'
value:
$ref: '#/components/schemas/Value45'
Protocol1:
title: Protocol1
enum:
- tcp
- udp
type: string
Rackface:
title: Rackface
enum:
- front
- rear
type: string
render:
title: render
enum:
- json
- svg
type: string
Role1:
title: Role1
enum:
- loopback
- secondary
- anycast
- vip
- vrrp
- hsrp
- glbp
- carp
type: string
description: The functional role of this IP
Role3:
title: Role3
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label42'
value:
$ref: '#/components/schemas/Value42'
secrets_secret-roles_listResponse:
title: secrets_secret-roles_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/SecretRole'
description: ''
secrets_secrets_listResponse:
title: secrets_secrets_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Secret'
description: ''
Status:
title: Status
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label'
value:
$ref: '#/components/schemas/Value'
Status1:
title: Status1
enum:
- planned
- provisioning
- active
- offline
- deprovisioning
- decommissioned
type: string
Status2:
title: Status2
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label1'
value:
$ref: '#/components/schemas/Value1'
Status3:
title: Status3
enum:
- connected
- planned
- decommissioning
type: string
Status4:
title: Status4
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label4'
value:
$ref: '#/components/schemas/Value4'
Status6:
title: Status6
enum:
- offline
- active
- planned
- staged
- failed
- inventory
- decommissioning
type: string
Status7:
title: Status7
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label18'
value:
$ref: '#/components/schemas/Value18'
Status8:
title: Status8
enum:
- offline
- active
- planned
- failed
type: string
Status9:
title: Status9
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label27'
value:
$ref: '#/components/schemas/Value27'
Status10:
title: Status10
enum:
- reserved
- available
- planned
- active
- deprecated
type: string
Status11:
title: Status11
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label34'
value:
$ref: '#/components/schemas/Value34'
Status12:
title: Status12
enum:
- planned
- staging
- active
- decommissioning
- retired
type: string
Status13:
title: Status13
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label37'
value:
$ref: '#/components/schemas/Value37'
Status14:
title: Status14
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label41'
value:
$ref: '#/components/schemas/Value41'
Status15:
title: Status15
enum:
- active
- reserved
- deprecated
- dhcp
- slaac
type: string
description: The operational status of this IP
Status16:
title: Status16
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label44'
value:
$ref: '#/components/schemas/Value44'
Status17:
title: Status17
enum:
- container
- active
- reserved
- deprecated
type: string
description: Operational status of this prefix
Status18:
title: Status18
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label46'
value:
$ref: '#/components/schemas/Value46'
Status19:
title: Status19
enum:
- active
- reserved
- deprecated
type: string
Status20:
title: Status20
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label48'
value:
$ref: '#/components/schemas/Value48'
Status21:
title: Status21
enum:
- offline
- active
- planned
- staged
- failed
- decommissioning
type: string
Subdevicerole:
title: Subdevicerole
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label9'
value:
$ref: '#/components/schemas/Value9'
Supply:
title: Supply
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label20'
value:
$ref: '#/components/schemas/Value20'
Supply1:
title: Supply1
enum:
- ac
- dc
type: string
tenancy_tenant-groups_listResponse:
title: tenancy_tenant-groups_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/TenantGroup'
description: ''
tenancy_tenants_listResponse:
title: tenancy_tenants_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Tenant'
description: ''
Termination:
title: Termination
enum:
- A
- Z
type: string
Type:
title: Type
enum:
- cat3
- cat5
- cat5e
- cat6
- cat6a
- cat7
- cat7a
- cat8
- dac-active
- dac-passive
- mrj21-trunk
- coaxial
- mmf
- mmf-om1
- mmf-om2
- mmf-om3
- mmf-om4
- smf
- smf-os1
- smf-os2
- aoc
- power
type: string
Type2:
title: Type2
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label5'
value:
$ref: '#/components/schemas/Value5'
Type4:
title: Type4
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- other
type: string
Type5:
title: Type5
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- other
type: string
description: Physical port type
Type10:
title: Type10
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label12'
value:
$ref: '#/components/schemas/Value12'
Type11:
title: Type11
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- mrj21
- fc
- lc
- lc-apc
- lsh
- lsh-apc
- mpo
- mtrj
- sc
- sc-apc
- st
- cs
- sn
- splice
type: string
Type14:
title: Type14
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label14'
value:
$ref: '#/components/schemas/Value14'
Type15:
title: Type15
enum:
- virtual
- lag
- 100base-tx
- 1000base-t
- 2.5gbase-t
- 5gbase-t
- 10gbase-t
- 10gbase-cx4
- 1000base-x-gbic
- 1000base-x-sfp
- 10gbase-x-sfpp
- 10gbase-x-xfp
- 10gbase-x-xenpak
- 10gbase-x-x2
- 25gbase-x-sfp28
- 40gbase-x-qsfpp
- 50gbase-x-sfp28
- 100gbase-x-cfp
- 100gbase-x-cfp2
- 200gbase-x-cfp2
- 100gbase-x-cfp4
- 100gbase-x-cpak
- 100gbase-x-qsfp28
- 200gbase-x-qsfp56
- 400gbase-x-qsfpdd
- 400gbase-x-osfp
- ieee802.11a
- ieee802.11g
- ieee802.11n
- ieee802.11ac
- ieee802.11ad
- ieee802.11ax
- gsm
- cdma
- lte
- sonet-oc3
- sonet-oc12
- sonet-oc48
- sonet-oc192
- sonet-oc768
- sonet-oc1920
- sonet-oc3840
- 1gfc-sfp
- 2gfc-sfp
- 4gfc-sfp
- 8gfc-sfpp
- 16gfc-sfpp
- 32gfc-sfp28
- 128gfc-sfp28
- infiniband-sdr
- infiniband-ddr
- infiniband-qdr
- infiniband-fdr10
- infiniband-fdr
- infiniband-edr
- infiniband-hdr
- infiniband-ndr
- infiniband-xdr
- t1
- e1
- t3
- e3
- cisco-stackwise
- cisco-stackwise-plus
- cisco-flexstack
- cisco-flexstack-plus
- juniper-vcp
- extreme-summitstack
- extreme-summitstack-128
- extreme-summitstack-256
- extreme-summitstack-512
- other
type: string
Type18:
title: Type18
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label17'
value:
$ref: '#/components/schemas/Value17'
Type19:
title: Type19
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label19'
value:
$ref: '#/components/schemas/Value19'
Type20:
title: Type20
enum:
- primary
- redundant
type: string
Type21:
title: Type21
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label22'
value:
$ref: '#/components/schemas/Value22'
Type22:
title: Type22
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-1-15r
- nema-5-15r
- nema-5-20r
- nema-5-30r
- nema-5-50r
- nema-6-15r
- nema-6-20r
- nema-6-30r
- nema-6-50r
- nema-10-30r
- nema-10-50r
- nema-14-20r
- nema-14-30r
- nema-14-50r
- nema-14-60r
- nema-15-15r
- nema-15-20r
- nema-15-30r
- nema-15-50r
- nema-15-60r
- nema-l1-15r
- nema-l5-15r
- nema-l5-20r
- nema-l5-30r
- nema-l5-50r
- nema-l6-15r
- nema-l6-20r
- nema-l6-30r
- nema-l6-50r
- nema-l10-30r
- nema-l14-20r
- nema-l14-30r
- nema-l14-50r
- nema-l14-60r
- nema-l15-20r
- nema-l15-30r
- nema-l15-50r
- nema-l15-60r
- nema-l21-20r
- nema-l21-30r
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ita-e
- ita-f
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- usb-a
- usb-micro-b
- usb-c
- hdot-cx
type: string
Type24:
title: Type24
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-1-15r
- nema-5-15r
- nema-5-20r
- nema-5-30r
- nema-5-50r
- nema-6-15r
- nema-6-20r
- nema-6-30r
- nema-6-50r
- nema-10-30r
- nema-10-50r
- nema-14-20r
- nema-14-30r
- nema-14-50r
- nema-14-60r
- nema-15-15r
- nema-15-20r
- nema-15-30r
- nema-15-50r
- nema-15-60r
- nema-l1-15r
- nema-l5-15r
- nema-l5-20r
- nema-l5-30r
- nema-l5-50r
- nema-l6-15r
- nema-l6-20r
- nema-l6-30r
- nema-l6-50r
- nema-l10-30r
- nema-l14-20r
- nema-l14-30r
- nema-l14-50r
- nema-l14-60r
- nema-l15-20r
- nema-l15-30r
- nema-l15-50r
- nema-l15-60r
- nema-l21-20r
- nema-l21-30r
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ita-e
- ita-f
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- usb-a
- usb-micro-b
- usb-c
- hdot-cx
type: string
description: Physical port type
Type26:
title: Type26
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-1-15p
- nema-5-15p
- nema-5-20p
- nema-5-30p
- nema-5-50p
- nema-6-15p
- nema-6-20p
- nema-6-30p
- nema-6-50p
- nema-10-30p
- nema-10-50p
- nema-14-20p
- nema-14-30p
- nema-14-50p
- nema-14-60p
- nema-15-15p
- nema-15-20p
- nema-15-30p
- nema-15-50p
- nema-15-60p
- nema-l1-15p
- nema-l5-15p
- nema-l5-20p
- nema-l5-30p
- nema-l5-50p
- nema-l6-15p
- nema-l6-20p
- nema-l6-30p
- nema-l6-50p
- nema-l10-30p
- nema-l14-20p
- nema-l14-30p
- nema-l14-50p
- nema-l14-60p
- nema-l15-20p
- nema-l15-30p
- nema-l15-50p
- nema-l15-60p
- nema-l21-20p
- nema-l21-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-e
- ita-f
- ita-ef
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-3-b
- usb-3-micro-b
type: string
Type27:
title: Type27
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-1-15p
- nema-5-15p
- nema-5-20p
- nema-5-30p
- nema-5-50p
- nema-6-15p
- nema-6-20p
- nema-6-30p
- nema-6-50p
- nema-10-30p
- nema-10-50p
- nema-14-20p
- nema-14-30p
- nema-14-50p
- nema-14-60p
- nema-15-15p
- nema-15-20p
- nema-15-30p
- nema-15-50p
- nema-15-60p
- nema-l1-15p
- nema-l5-15p
- nema-l5-20p
- nema-l5-30p
- nema-l5-50p
- nema-l6-15p
- nema-l6-20p
- nema-l6-30p
- nema-l6-50p
- nema-l10-30p
- nema-l14-20p
- nema-l14-30p
- nema-l14-50p
- nema-l14-60p
- nema-l15-20p
- nema-l15-30p
- nema-l15-50p
- nema-l15-60p
- nema-l21-20p
- nema-l21-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-e
- ita-f
- ita-ef
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-3-b
- usb-3-micro-b
type: string
description: Physical port type
Type28:
title: Type28
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label28'
value:
$ref: '#/components/schemas/Value28'
Type29:
title: Type29
enum:
- 2-post-frame
- 4-post-frame
- 4-post-cabinet
- wall-frame
- wall-cabinet
type: string
Type34:
title: Type34
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label35'
value:
$ref: '#/components/schemas/Value35'
Type35:
title: Type35
enum:
- text
- integer
- boolean
- date
- url
- select
type: string
users_groups_listResponse:
title: users_groups_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Group'
description: ''
users_permissions_listResponse:
title: users_permissions_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ObjectPermission'
description: ''
users_users_listResponse:
title: users_users_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/User'
description: ''
Value:
title: Value
enum:
- planned
- provisioning
- active
- offline
- deprovisioning
- decommissioned
type: string
Value1:
title: Value1
enum:
- connected
- planned
- decommissioning
type: string
Value2:
title: Value2
enum:
- m
- cm
- ft
- in
type: string
Value3:
title: Value3
enum:
- front
- rear
type: string
Value4:
title: Value4
enum:
- offline
- active
- planned
- staged
- failed
- inventory
- decommissioning
type: string
Value5:
title: Value5
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- other
type: string
Value9:
title: Value9
enum:
- parent
- child
type: string
Value12:
title: Value12
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- mrj21
- fc
- lc
- lc-apc
- lsh
- lsh-apc
- mpo
- mtrj
- sc
- sc-apc
- st
- cs
- sn
- splice
type: string
Value14:
title: Value14
enum:
- virtual
- lag
- 100base-tx
- 1000base-t
- 2.5gbase-t
- 5gbase-t
- 10gbase-t
- 10gbase-cx4
- 1000base-x-gbic
- 1000base-x-sfp
- 10gbase-x-sfpp
- 10gbase-x-xfp
- 10gbase-x-xenpak
- 10gbase-x-x2
- 25gbase-x-sfp28
- 40gbase-x-qsfpp
- 50gbase-x-sfp28
- 100gbase-x-cfp
- 100gbase-x-cfp2
- 200gbase-x-cfp2
- 100gbase-x-cfp4
- 100gbase-x-cpak
- 100gbase-x-qsfp28
- 200gbase-x-qsfp56
- 400gbase-x-qsfpdd
- 400gbase-x-osfp
- ieee802.11a
- ieee802.11g
- ieee802.11n
- ieee802.11ac
- ieee802.11ad
- ieee802.11ax
- gsm
- cdma
- lte
- sonet-oc3
- sonet-oc12
- sonet-oc48
- sonet-oc192
- sonet-oc768
- sonet-oc1920
- sonet-oc3840
- 1gfc-sfp
- 2gfc-sfp
- 4gfc-sfp
- 8gfc-sfpp
- 16gfc-sfpp
- 32gfc-sfp28
- 128gfc-sfp28
- infiniband-sdr
- infiniband-ddr
- infiniband-qdr
- infiniband-fdr10
- infiniband-fdr
- infiniband-edr
- infiniband-hdr
- infiniband-ndr
- infiniband-xdr
- t1
- e1
- t3
- e3
- cisco-stackwise
- cisco-stackwise-plus
- cisco-flexstack
- cisco-flexstack-plus
- juniper-vcp
- extreme-summitstack
- extreme-summitstack-128
- extreme-summitstack-256
- extreme-summitstack-512
- other
type: string
Value16:
title: Value16
enum:
- access
- tagged
- tagged-all
type: string
Value17:
title: Value17
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-1-15p
- nema-5-15p
- nema-5-20p
- nema-5-30p
- nema-5-50p
- nema-6-15p
- nema-6-20p
- nema-6-30p
- nema-6-50p
- nema-10-30p
- nema-10-50p
- nema-14-20p
- nema-14-30p
- nema-14-50p
- nema-14-60p
- nema-15-15p
- nema-15-20p
- nema-15-30p
- nema-15-50p
- nema-15-60p
- nema-l1-15p
- nema-l5-15p
- nema-l5-20p
- nema-l5-30p
- nema-l5-50p
- nema-l6-15p
- nema-l6-20p
- nema-l6-30p
- nema-l6-50p
- nema-l10-30p
- nema-l14-20p
- nema-l14-30p
- nema-l14-50p
- nema-l14-60p
- nema-l15-20p
- nema-l15-30p
- nema-l15-50p
- nema-l15-60p
- nema-l21-20p
- nema-l21-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-e
- ita-f
- ita-ef
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-3-b
- usb-3-micro-b
type: string
Value18:
title: Value18
enum:
- offline
- active
- planned
- failed
type: string
Value19:
title: Value19
enum:
- primary
- redundant
type: string
Value20:
title: Value20
enum:
- ac
- dc
type: string
Value21:
title: Value21
enum:
- single-phase
- three-phase
type: string
Value22:
title: Value22
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-1-15r
- nema-5-15r
- nema-5-20r
- nema-5-30r
- nema-5-50r
- nema-6-15r
- nema-6-20r
- nema-6-30r
- nema-6-50r
- nema-10-30r
- nema-10-50r
- nema-14-20r
- nema-14-30r
- nema-14-50r
- nema-14-60r
- nema-15-15r
- nema-15-20r
- nema-15-30r
- nema-15-50r
- nema-15-60r
- nema-l1-15r
- nema-l5-15r
- nema-l5-20r
- nema-l5-30r
- nema-l5-50r
- nema-l6-15r
- nema-l6-20r
- nema-l6-30r
- nema-l6-50r
- nema-l10-30r
- nema-l14-20r
- nema-l14-30r
- nema-l14-50r
- nema-l14-60r
- nema-l15-20r
- nema-l15-30r
- nema-l15-50r
- nema-l15-60r
- nema-l21-20r
- nema-l21-30r
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ita-e
- ita-f
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- usb-a
- usb-micro-b
- usb-c
- hdot-cx
type: string
Value23:
title: Value23
enum:
- A
- B
- C
type: string
Value27:
title: Value27
enum:
- reserved
- available
- planned
- active
- deprecated
type: string
Value28:
title: Value28
enum:
- 2-post-frame
- 4-post-frame
- 4-post-cabinet
- wall-frame
- wall-cabinet
type: string
Value29:
title: Value29
enum:
- 10
- 19
- 21
- 23
type: integer
Value30:
title: Value30
enum:
- mm
- in
type: string
Value34:
title: Value34
enum:
- planned
- staging
- active
- decommissioning
- retired
type: string
Value35:
title: Value35
enum:
- text
- integer
- boolean
- date
- url
- select
type: string
Value36:
title: Value36
enum:
- disabled
- loose
- exact
type: string
Value37:
title: Value37
enum:
- pending
- running
- completed
- errored
- failed
type: string
Value38:
title: Value38
enum:
- create
- update
- delete
type: string
Value39:
title: Value39
enum:
- 4
- 6
type: integer
Value41:
title: Value41
enum:
- active
- reserved
- deprecated
- dhcp
- slaac
type: string
Value42:
title: Value42
enum:
- loopback
- secondary
- anycast
- vip
- vrrp
- hsrp
- glbp
- carp
type: string
Value44:
title: Value44
enum:
- container
- active
- reserved
- deprecated
type: string
Value45:
title: Value45
enum:
- tcp
- udp
type: string
Value46:
title: Value46
enum:
- active
- reserved
- deprecated
type: string
Value48:
title: Value48
enum:
- offline
- active
- planned
- staged
- failed
- decommissioning
type: string
virtualization_cluster-groups_listResponse:
title: virtualization_cluster-groups_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ClusterGroup'
description: ''
virtualization_clusters_listResponse:
title: virtualization_clusters_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/Cluster'
description: ''
virtualization_cluster-types_listResponse:
title: virtualization_cluster-types_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ClusterType'
description: ''
virtualization_interfaces_listResponse:
title: virtualization_interfaces_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/VMInterface'
description: ''
virtualization_virtual-machines_listResponse:
title: virtualization_virtual-machines_listResponse
required:
- count
- results
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
results:
type: array
items:
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
description: ''
Width:
title: Width
required:
- label
- value
type: object
properties:
label:
$ref: '#/components/schemas/Label29'
value:
$ref: '#/components/schemas/Value29'
Width1:
title: Width1
enum:
- 10
- 19
- 21
- 23
type: integer
description: Rail-to-rail width
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header
security:
- Bearer: []
tags:
- name: circuits
description: ''
- name: dcim
description: ''
- name: extras
description: ''
- name: ipam
description: ''
- name: secrets
description: ''
- name: status
description: ''
- name: tenancy
description: ''
- name: users
description: ''
- name: virtualization
description: ''