1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Files
netbox-community-netbox/contrib/openapi2.yaml
2023-03-30 13:34:08 -04:00

69696 lines
1.6 MiB

swagger: '2.0'
info:
title: NetBox API
description: API to access NetBox
termsOfService: https://github.com/netbox-community/netbox
license:
name: Apache v2 License
version: '3.5'
basePath: /api
consumes:
- application/json
produces:
- application/json
securityDefinitions:
Bearer:
type: apiKey
name: Authorization
in: header
security:
- Bearer: []
paths:
/circuits/circuit-terminations/:
get:
operationId: circuits_circuit-terminations_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: term_side
in: query
description: ''
required: false
type: string
- name: port_speed
in: query
description: ''
required: false
type: string
- name: upstream_speed
in: query
description: ''
required: false
type: string
- name: xconnect_id
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: circuit_id
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: provider_network_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: term_side__n
in: query
description: ''
required: false
type: string
- name: port_speed__n
in: query
description: ''
required: false
type: string
- name: port_speed__lte
in: query
description: ''
required: false
type: string
- name: port_speed__lt
in: query
description: ''
required: false
type: string
- name: port_speed__gte
in: query
description: ''
required: false
type: string
- name: port_speed__gt
in: query
description: ''
required: false
type: string
- name: upstream_speed__n
in: query
description: ''
required: false
type: string
- name: upstream_speed__lte
in: query
description: ''
required: false
type: string
- name: upstream_speed__lt
in: query
description: ''
required: false
type: string
- name: upstream_speed__gte
in: query
description: ''
required: false
type: string
- name: upstream_speed__gt
in: query
description: ''
required: false
type: string
- name: xconnect_id__n
in: query
description: ''
required: false
type: string
- name: xconnect_id__ic
in: query
description: ''
required: false
type: string
- name: xconnect_id__nic
in: query
description: ''
required: false
type: string
- name: xconnect_id__iew
in: query
description: ''
required: false
type: string
- name: xconnect_id__niew
in: query
description: ''
required: false
type: string
- name: xconnect_id__isw
in: query
description: ''
required: false
type: string
- name: xconnect_id__nisw
in: query
description: ''
required: false
type: string
- name: xconnect_id__ie
in: query
description: ''
required: false
type: string
- name: xconnect_id__nie
in: query
description: ''
required: false
type: string
- name: xconnect_id__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: circuit_id__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: provider_network_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
post:
operationId: circuits_circuit-terminations_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuitTermination'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
put:
operationId: circuits_circuit-terminations_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuitTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
patch:
operationId: circuits_circuit-terminations_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuitTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
delete:
operationId: circuits_circuit-terminations_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters: []
/circuits/circuit-terminations/{id}/:
get:
operationId: circuits_circuit-terminations_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
put:
operationId: circuits_circuit-terminations_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuitTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
patch:
operationId: circuits_circuit-terminations_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuitTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
delete:
operationId: circuits_circuit-terminations_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
type: integer
/circuits/circuit-terminations/{id}/paths/:
get:
operationId: circuits_circuit-terminations_paths
description: Return all CablePaths which traverse a given pass-through port.
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitTermination'
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit termination.
required: true
type: integer
/circuits/circuit-types/:
get:
operationId: circuits_circuit-types_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CircuitType'
tags:
- circuits
post:
operationId: circuits_circuit-types_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CircuitType'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CircuitType'
tags:
- circuits
put:
operationId: circuits_circuit-types_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CircuitType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitType'
tags:
- circuits
patch:
operationId: circuits_circuit-types_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CircuitType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitType'
tags:
- circuits
delete:
operationId: circuits_circuit-types_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters: []
/circuits/circuit-types/{id}/:
get:
operationId: circuits_circuit-types_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitType'
tags:
- circuits
put:
operationId: circuits_circuit-types_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CircuitType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitType'
tags:
- circuits
patch:
operationId: circuits_circuit-types_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CircuitType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CircuitType'
tags:
- circuits
delete:
operationId: circuits_circuit-types_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit type.
required: true
type: integer
/circuits/circuits/:
get:
operationId: circuits_circuits_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: cid
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: install_date
in: query
description: ''
required: false
type: string
- name: termination_date
in: query
description: ''
required: false
type: string
- name: commit_rate
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: provider_id
in: query
description: ''
required: false
type: string
- name: provider
in: query
description: ''
required: false
type: string
- name: provider_account_id
in: query
description: ''
required: false
type: string
- name: provider_network_id
in: query
description: ''
required: false
type: string
- name: type_id
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: cid__n
in: query
description: ''
required: false
type: string
- name: cid__ic
in: query
description: ''
required: false
type: string
- name: cid__nic
in: query
description: ''
required: false
type: string
- name: cid__iew
in: query
description: ''
required: false
type: string
- name: cid__niew
in: query
description: ''
required: false
type: string
- name: cid__isw
in: query
description: ''
required: false
type: string
- name: cid__nisw
in: query
description: ''
required: false
type: string
- name: cid__ie
in: query
description: ''
required: false
type: string
- name: cid__nie
in: query
description: ''
required: false
type: string
- name: cid__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: install_date__n
in: query
description: ''
required: false
type: string
- name: install_date__lte
in: query
description: ''
required: false
type: string
- name: install_date__lt
in: query
description: ''
required: false
type: string
- name: install_date__gte
in: query
description: ''
required: false
type: string
- name: install_date__gt
in: query
description: ''
required: false
type: string
- name: termination_date__n
in: query
description: ''
required: false
type: string
- name: termination_date__lte
in: query
description: ''
required: false
type: string
- name: termination_date__lt
in: query
description: ''
required: false
type: string
- name: termination_date__gte
in: query
description: ''
required: false
type: string
- name: termination_date__gt
in: query
description: ''
required: false
type: string
- name: commit_rate__n
in: query
description: ''
required: false
type: string
- name: commit_rate__lte
in: query
description: ''
required: false
type: string
- name: commit_rate__lt
in: query
description: ''
required: false
type: string
- name: commit_rate__gte
in: query
description: ''
required: false
type: string
- name: commit_rate__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: provider_id__n
in: query
description: ''
required: false
type: string
- name: provider__n
in: query
description: ''
required: false
type: string
- name: provider_account_id__n
in: query
description: ''
required: false
type: string
- name: provider_network_id__n
in: query
description: ''
required: false
type: string
- name: type_id__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Circuit'
tags:
- circuits
post:
operationId: circuits_circuits_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuit'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Circuit'
tags:
- circuits
put:
operationId: circuits_circuits_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuit'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Circuit'
tags:
- circuits
patch:
operationId: circuits_circuits_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuit'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Circuit'
tags:
- circuits
delete:
operationId: circuits_circuits_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters: []
/circuits/circuits/{id}/:
get:
operationId: circuits_circuits_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Circuit'
tags:
- circuits
put:
operationId: circuits_circuits_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuit'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Circuit'
tags:
- circuits
patch:
operationId: circuits_circuits_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCircuit'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Circuit'
tags:
- circuits
delete:
operationId: circuits_circuits_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this circuit.
required: true
type: integer
/circuits/provider-accounts/:
get:
operationId: circuits_provider-accounts_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: account
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: provider_id
in: query
description: ''
required: false
type: string
- name: provider
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: account__n
in: query
description: ''
required: false
type: string
- name: account__ic
in: query
description: ''
required: false
type: string
- name: account__nic
in: query
description: ''
required: false
type: string
- name: account__iew
in: query
description: ''
required: false
type: string
- name: account__niew
in: query
description: ''
required: false
type: string
- name: account__isw
in: query
description: ''
required: false
type: string
- name: account__nisw
in: query
description: ''
required: false
type: string
- name: account__ie
in: query
description: ''
required: false
type: string
- name: account__nie
in: query
description: ''
required: false
type: string
- name: account__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: provider_id__n
in: query
description: ''
required: false
type: string
- name: provider__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
post:
operationId: circuits_provider-accounts_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderAccount'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
put:
operationId: circuits_provider-accounts_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderAccount'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
patch:
operationId: circuits_provider-accounts_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderAccount'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
delete:
operationId: circuits_provider-accounts_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters: []
/circuits/provider-accounts/{id}/:
get:
operationId: circuits_provider-accounts_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
put:
operationId: circuits_provider-accounts_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderAccount'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
patch:
operationId: circuits_provider-accounts_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderAccount'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderAccount'
tags:
- circuits
delete:
operationId: circuits_provider-accounts_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this provider account.
required: true
type: integer
/circuits/provider-networks/:
get:
operationId: circuits_provider-networks_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: service_id
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: provider_id
in: query
description: ''
required: false
type: string
- name: provider
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: service_id__n
in: query
description: ''
required: false
type: string
- name: service_id__ic
in: query
description: ''
required: false
type: string
- name: service_id__nic
in: query
description: ''
required: false
type: string
- name: service_id__iew
in: query
description: ''
required: false
type: string
- name: service_id__niew
in: query
description: ''
required: false
type: string
- name: service_id__isw
in: query
description: ''
required: false
type: string
- name: service_id__nisw
in: query
description: ''
required: false
type: string
- name: service_id__ie
in: query
description: ''
required: false
type: string
- name: service_id__nie
in: query
description: ''
required: false
type: string
- name: service_id__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: provider_id__n
in: query
description: ''
required: false
type: string
- name: provider__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
post:
operationId: circuits_provider-networks_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderNetwork'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
put:
operationId: circuits_provider-networks_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderNetwork'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
patch:
operationId: circuits_provider-networks_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderNetwork'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
delete:
operationId: circuits_provider-networks_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters: []
/circuits/provider-networks/{id}/:
get:
operationId: circuits_provider-networks_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
put:
operationId: circuits_provider-networks_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderNetwork'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
patch:
operationId: circuits_provider-networks_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProviderNetwork'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProviderNetwork'
tags:
- circuits
delete:
operationId: circuits_provider-networks_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this provider network.
required: true
type: integer
/circuits/providers/:
get:
operationId: circuits_providers_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: asn_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: asn_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Provider'
tags:
- circuits
post:
operationId: circuits_providers_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProvider'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- circuits
put:
operationId: circuits_providers_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- circuits
patch:
operationId: circuits_providers_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- circuits
delete:
operationId: circuits_providers_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters: []
/circuits/providers/{id}/:
get:
operationId: circuits_providers_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- circuits
put:
operationId: circuits_providers_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- circuits
patch:
operationId: circuits_providers_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- circuits
delete:
operationId: circuits_providers_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- circuits
parameters:
- name: id
in: path
description: A unique integer value identifying this provider.
required: true
type: integer
/core/data-files/:
get:
operationId: core_data-files_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: path
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: size
in: query
description: ''
required: false
type: string
- name: hash
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: source_id
in: query
description: ''
required: false
type: string
- name: source
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: path__n
in: query
description: ''
required: false
type: string
- name: path__ic
in: query
description: ''
required: false
type: string
- name: path__nic
in: query
description: ''
required: false
type: string
- name: path__iew
in: query
description: ''
required: false
type: string
- name: path__niew
in: query
description: ''
required: false
type: string
- name: path__isw
in: query
description: ''
required: false
type: string
- name: path__nisw
in: query
description: ''
required: false
type: string
- name: path__ie
in: query
description: ''
required: false
type: string
- name: path__nie
in: query
description: ''
required: false
type: string
- name: path__empty
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: size__n
in: query
description: ''
required: false
type: string
- name: size__lte
in: query
description: ''
required: false
type: string
- name: size__lt
in: query
description: ''
required: false
type: string
- name: size__gte
in: query
description: ''
required: false
type: string
- name: size__gt
in: query
description: ''
required: false
type: string
- name: hash__n
in: query
description: ''
required: false
type: string
- name: hash__ic
in: query
description: ''
required: false
type: string
- name: hash__nic
in: query
description: ''
required: false
type: string
- name: hash__iew
in: query
description: ''
required: false
type: string
- name: hash__niew
in: query
description: ''
required: false
type: string
- name: hash__isw
in: query
description: ''
required: false
type: string
- name: hash__nisw
in: query
description: ''
required: false
type: string
- name: hash__ie
in: query
description: ''
required: false
type: string
- name: hash__nie
in: query
description: ''
required: false
type: string
- name: hash__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: source_id__n
in: query
description: ''
required: false
type: string
- name: source__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DataFile'
tags:
- core
parameters: []
/core/data-files/{id}/:
get:
operationId: core_data-files_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DataFile'
tags:
- core
parameters:
- name: id
in: path
description: A unique integer value identifying this data file.
required: true
type: integer
/core/data-sources/:
get:
operationId: core_data-sources_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DataSource'
tags:
- core
post:
operationId: core_data-sources_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDataSource'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
put:
operationId: core_data-sources_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDataSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
patch:
operationId: core_data-sources_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDataSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
delete:
operationId: core_data-sources_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- core
parameters: []
/core/data-sources/{id}/:
get:
operationId: core_data-sources_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
put:
operationId: core_data-sources_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDataSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
patch:
operationId: core_data-sources_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDataSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
delete:
operationId: core_data-sources_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- core
parameters:
- name: id
in: path
description: A unique integer value identifying this data source.
required: true
type: integer
/core/data-sources/{id}/sync/:
post:
operationId: core_data-sources_sync
description: Enqueue a job to synchronize the DataSource.
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDataSource'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DataSource'
tags:
- core
parameters:
- name: id
in: path
description: A unique integer value identifying this data source.
required: true
type: integer
/core/jobs/:
get:
operationId: core_jobs_list
description: Retrieve a list of job results
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: object_type
in: query
description: ''
required: false
type: string
- name: object_id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: interval
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: user
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: created__before
in: query
description: ''
required: false
type: string
- name: created__after
in: query
description: ''
required: false
type: string
- name: scheduled
in: query
description: ''
required: false
type: string
- name: scheduled__before
in: query
description: ''
required: false
type: string
- name: scheduled__after
in: query
description: ''
required: false
type: string
- name: started
in: query
description: ''
required: false
type: string
- name: started__before
in: query
description: ''
required: false
type: string
- name: started__after
in: query
description: ''
required: false
type: string
- name: completed
in: query
description: ''
required: false
type: string
- name: completed__before
in: query
description: ''
required: false
type: string
- name: completed__after
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: object_type__n
in: query
description: ''
required: false
type: string
- name: object_id__n
in: query
description: ''
required: false
type: string
- name: object_id__lte
in: query
description: ''
required: false
type: string
- name: object_id__lt
in: query
description: ''
required: false
type: string
- name: object_id__gte
in: query
description: ''
required: false
type: string
- name: object_id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: interval__n
in: query
description: ''
required: false
type: string
- name: interval__lte
in: query
description: ''
required: false
type: string
- name: interval__lt
in: query
description: ''
required: false
type: string
- name: interval__gte
in: query
description: ''
required: false
type: string
- name: interval__gt
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: user__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Job'
tags:
- core
parameters: []
/core/jobs/{id}/:
get:
operationId: core_jobs_read
description: Retrieve a list of job results
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Job'
tags:
- core
parameters:
- name: id
in: path
description: A unique integer value identifying this job.
required: true
type: integer
/dcim/cable-terminations/:
get:
operationId: dcim_cable-terminations_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: cable
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: termination_type
in: query
description: ''
required: false
type: string
- name: termination_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: cable__n
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: termination_type__n
in: query
description: ''
required: false
type: string
- name: termination_id__n
in: query
description: ''
required: false
type: string
- name: termination_id__lte
in: query
description: ''
required: false
type: string
- name: termination_id__lt
in: query
description: ''
required: false
type: string
- name: termination_id__gte
in: query
description: ''
required: false
type: string
- name: termination_id__gt
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CableTermination'
tags:
- dcim
post:
operationId: dcim_cable-terminations_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CableTermination'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CableTermination'
tags:
- dcim
put:
operationId: dcim_cable-terminations_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CableTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CableTermination'
tags:
- dcim
patch:
operationId: dcim_cable-terminations_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CableTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CableTermination'
tags:
- dcim
delete:
operationId: dcim_cable-terminations_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/cable-terminations/{id}/:
get:
operationId: dcim_cable-terminations_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CableTermination'
tags:
- dcim
put:
operationId: dcim_cable-terminations_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CableTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CableTermination'
tags:
- dcim
patch:
operationId: dcim_cable-terminations_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CableTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CableTermination'
tags:
- dcim
delete:
operationId: dcim_cable-terminations_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this cable termination.
required: true
type: integer
/dcim/cables/:
get:
operationId: dcim_cables_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: length
in: query
description: ''
required: false
type: string
- name: length_unit
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: termination_a_type
in: query
description: ''
required: false
type: string
- name: termination_a_id
in: query
description: ''
required: false
type: string
- name: termination_b_type
in: query
description: ''
required: false
type: string
- name: termination_b_id
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: length__n
in: query
description: ''
required: false
type: string
- name: length__lte
in: query
description: ''
required: false
type: string
- name: length__lt
in: query
description: ''
required: false
type: string
- name: length__gte
in: query
description: ''
required: false
type: string
- name: length__gt
in: query
description: ''
required: false
type: string
- name: length_unit__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: termination_a_type__n
in: query
description: ''
required: false
type: string
- name: termination_a_id__n
in: query
description: ''
required: false
type: string
- name: termination_a_id__lte
in: query
description: ''
required: false
type: string
- name: termination_a_id__lt
in: query
description: ''
required: false
type: string
- name: termination_a_id__gte
in: query
description: ''
required: false
type: string
- name: termination_a_id__gt
in: query
description: ''
required: false
type: string
- name: termination_b_type__n
in: query
description: ''
required: false
type: string
- name: termination_b_id__n
in: query
description: ''
required: false
type: string
- name: termination_b_id__lte
in: query
description: ''
required: false
type: string
- name: termination_b_id__lt
in: query
description: ''
required: false
type: string
- name: termination_b_id__gte
in: query
description: ''
required: false
type: string
- name: termination_b_id__gt
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Cable'
tags:
- dcim
post:
operationId: dcim_cables_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCable'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Cable'
tags:
- dcim
put:
operationId: dcim_cables_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCable'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cable'
tags:
- dcim
patch:
operationId: dcim_cables_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCable'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cable'
tags:
- dcim
delete:
operationId: dcim_cables_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/cables/{id}/:
get:
operationId: dcim_cables_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cable'
tags:
- dcim
put:
operationId: dcim_cables_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCable'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cable'
tags:
- dcim
patch:
operationId: dcim_cables_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCable'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cable'
tags:
- dcim
delete:
operationId: dcim_cables_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this cable.
required: true
type: integer
/dcim/connected-device/:
get:
operationId: 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
parameters:
- name: peer_device
in: query
description: The name of the peer device
required: true
type: string
- name: peer_interface
in: query
description: The name of the peer interface
required: true
type: string
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Device'
tags:
- dcim
parameters: []
/dcim/console-port-templates/:
get:
operationId: dcim_console-port-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
post:
operationId: dcim_console-port-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePortTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
put:
operationId: dcim_console-port-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
patch:
operationId: dcim_console-port-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
delete:
operationId: dcim_console-port-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/console-port-templates/{id}/:
get:
operationId: dcim_console-port-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
put:
operationId: dcim_console-port-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
patch:
operationId: dcim_console-port-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePortTemplate'
tags:
- dcim
delete:
operationId: dcim_console-port-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this console port template.
required: true
type: integer
/dcim/console-ports/:
get:
operationId: dcim_console-ports_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: connected
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
post:
operationId: dcim_console-ports_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePort'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
put:
operationId: dcim_console-ports_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
patch:
operationId: dcim_console-ports_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
delete:
operationId: dcim_console-ports_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/console-ports/{id}/:
get:
operationId: dcim_console-ports_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
put:
operationId: dcim_console-ports_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
patch:
operationId: dcim_console-ports_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsolePort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
delete:
operationId: dcim_console-ports_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
type: integer
/dcim/console-ports/{id}/trace/:
get:
operationId: dcim_console-ports_trace
description: Trace a complete cable path and return each segment as a three-tuple
of (termination, cable, termination).
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsolePort'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this console port.
required: true
type: integer
/dcim/console-server-port-templates/:
get:
operationId: dcim_console-server-port-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
post:
operationId: dcim_console-server-port-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPortTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
put:
operationId: dcim_console-server-port-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
patch:
operationId: dcim_console-server-port-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
delete:
operationId: dcim_console-server-port-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/console-server-port-templates/{id}/:
get:
operationId: dcim_console-server-port-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
put:
operationId: dcim_console-server-port-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
patch:
operationId: dcim_console-server-port-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPortTemplate'
tags:
- dcim
delete:
operationId: dcim_console-server-port-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port template.
required: true
type: integer
/dcim/console-server-ports/:
get:
operationId: dcim_console-server-ports_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: connected
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
post:
operationId: dcim_console-server-ports_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPort'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
put:
operationId: dcim_console-server-ports_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
patch:
operationId: dcim_console-server-ports_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
delete:
operationId: dcim_console-server-ports_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/console-server-ports/{id}/:
get:
operationId: dcim_console-server-ports_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
put:
operationId: dcim_console-server-ports_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
patch:
operationId: dcim_console-server-ports_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConsoleServerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
delete:
operationId: dcim_console-server-ports_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
type: integer
/dcim/console-server-ports/{id}/trace/:
get:
operationId: dcim_console-server-ports_trace
description: Trace a complete cable path and return each segment as a three-tuple
of (termination, cable, termination).
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsoleServerPort'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this console server port.
required: true
type: integer
/dcim/device-bay-templates/:
get:
operationId: dcim_device-bay-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
post:
operationId: dcim_device-bay-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBayTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
put:
operationId: dcim_device-bay-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
patch:
operationId: dcim_device-bay-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
delete:
operationId: dcim_device-bay-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/device-bay-templates/{id}/:
get:
operationId: dcim_device-bay-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
put:
operationId: dcim_device-bay-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
patch:
operationId: dcim_device-bay-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBayTemplate'
tags:
- dcim
delete:
operationId: dcim_device-bay-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay template.
required: true
type: integer
/dcim/device-bays/:
get:
operationId: dcim_device-bays_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
post:
operationId: dcim_device-bays_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBay'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
put:
operationId: dcim_device-bays_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
patch:
operationId: dcim_device-bays_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
delete:
operationId: dcim_device-bays_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/device-bays/{id}/:
get:
operationId: dcim_device-bays_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
put:
operationId: dcim_device-bays_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
patch:
operationId: dcim_device-bays_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceBay'
tags:
- dcim
delete:
operationId: dcim_device-bays_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this device bay.
required: true
type: integer
/dcim/device-roles/:
get:
operationId: dcim_device-roles_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: vm_role
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: config_template_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: config_template_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
post:
operationId: dcim_device-roles_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceRole'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
put:
operationId: dcim_device-roles_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
patch:
operationId: dcim_device-roles_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
delete:
operationId: dcim_device-roles_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/device-roles/{id}/:
get:
operationId: dcim_device-roles_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
put:
operationId: dcim_device-roles_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
patch:
operationId: dcim_device-roles_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceRole'
tags:
- dcim
delete:
operationId: dcim_device-roles_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this device role.
required: true
type: integer
/dcim/device-types/:
get:
operationId: dcim_device-types_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: model
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: part_number
in: query
description: ''
required: false
type: string
- name: u_height
in: query
description: ''
required: false
type: string
- name: is_full_depth
in: query
description: ''
required: false
type: string
- name: subdevice_role
in: query
description: ''
required: false
type: string
- name: airflow
in: query
description: ''
required: false
type: string
- name: weight
in: query
description: ''
required: false
type: string
- name: weight_unit
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: default_platform_id
in: query
description: ''
required: false
type: string
- name: default_platform
in: query
description: ''
required: false
type: string
- name: has_front_image
in: query
description: ''
required: false
type: string
- name: has_rear_image
in: query
description: ''
required: false
type: string
- name: console_ports
in: query
description: ''
required: false
type: string
- name: console_server_ports
in: query
description: ''
required: false
type: string
- name: power_ports
in: query
description: ''
required: false
type: string
- name: power_outlets
in: query
description: ''
required: false
type: string
- name: interfaces
in: query
description: ''
required: false
type: string
- name: pass_through_ports
in: query
description: ''
required: false
type: string
- name: module_bays
in: query
description: ''
required: false
type: string
- name: device_bays
in: query
description: ''
required: false
type: string
- name: inventory_items
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: model__n
in: query
description: ''
required: false
type: string
- name: model__ic
in: query
description: ''
required: false
type: string
- name: model__nic
in: query
description: ''
required: false
type: string
- name: model__iew
in: query
description: ''
required: false
type: string
- name: model__niew
in: query
description: ''
required: false
type: string
- name: model__isw
in: query
description: ''
required: false
type: string
- name: model__nisw
in: query
description: ''
required: false
type: string
- name: model__ie
in: query
description: ''
required: false
type: string
- name: model__nie
in: query
description: ''
required: false
type: string
- name: model__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: part_number__n
in: query
description: ''
required: false
type: string
- name: part_number__ic
in: query
description: ''
required: false
type: string
- name: part_number__nic
in: query
description: ''
required: false
type: string
- name: part_number__iew
in: query
description: ''
required: false
type: string
- name: part_number__niew
in: query
description: ''
required: false
type: string
- name: part_number__isw
in: query
description: ''
required: false
type: string
- name: part_number__nisw
in: query
description: ''
required: false
type: string
- name: part_number__ie
in: query
description: ''
required: false
type: string
- name: part_number__nie
in: query
description: ''
required: false
type: string
- name: part_number__empty
in: query
description: ''
required: false
type: string
- name: u_height__n
in: query
description: ''
required: false
type: string
- name: u_height__lte
in: query
description: ''
required: false
type: string
- name: u_height__lt
in: query
description: ''
required: false
type: string
- name: u_height__gte
in: query
description: ''
required: false
type: string
- name: u_height__gt
in: query
description: ''
required: false
type: string
- name: subdevice_role__n
in: query
description: ''
required: false
type: string
- name: airflow__n
in: query
description: ''
required: false
type: string
- name: weight__n
in: query
description: ''
required: false
type: string
- name: weight__lte
in: query
description: ''
required: false
type: string
- name: weight__lt
in: query
description: ''
required: false
type: string
- name: weight__gte
in: query
description: ''
required: false
type: string
- name: weight__gt
in: query
description: ''
required: false
type: string
- name: weight_unit__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: default_platform_id__n
in: query
description: ''
required: false
type: string
- name: default_platform__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DeviceType'
tags:
- dcim
post:
operationId: dcim_device-types_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceType'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DeviceType'
tags:
- dcim
put:
operationId: dcim_device-types_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceType'
tags:
- dcim
patch:
operationId: dcim_device-types_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceType'
tags:
- dcim
delete:
operationId: dcim_device-types_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/device-types/{id}/:
get:
operationId: dcim_device-types_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceType'
tags:
- dcim
put:
operationId: dcim_device-types_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceType'
tags:
- dcim
patch:
operationId: dcim_device-types_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableDeviceType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DeviceType'
tags:
- dcim
delete:
operationId: dcim_device-types_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this device type.
required: true
type: integer
/dcim/devices/:
get:
operationId: dcim_devices_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: asset_tag
in: query
description: ''
required: false
type: string
- name: face
in: query
description: ''
required: false
type: string
- name: position
in: query
description: ''
required: false
type: string
- name: airflow
in: query
description: ''
required: false
type: string
- name: vc_position
in: query
description: ''
required: false
type: string
- name: vc_priority
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: local_context_data
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: device_type
in: query
description: ''
required: false
type: string
- name: device_type_id
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: parent_device_id
in: query
description: ''
required: false
type: string
- name: platform_id
in: query
description: ''
required: false
type: string
- name: platform
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: cluster_id
in: query
description: ''
required: false
type: string
- name: model
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: is_full_depth
in: query
description: ''
required: false
type: string
- name: mac_address
in: query
description: ''
required: false
type: string
- name: serial
in: query
description: ''
required: false
type: string
- name: has_primary_ip
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis_member
in: query
description: ''
required: false
type: string
- name: config_template_id
in: query
description: ''
required: false
type: string
- name: console_ports
in: query
description: ''
required: false
type: string
- name: console_server_ports
in: query
description: ''
required: false
type: string
- name: power_ports
in: query
description: ''
required: false
type: string
- name: power_outlets
in: query
description: ''
required: false
type: string
- name: interfaces
in: query
description: ''
required: false
type: string
- name: pass_through_ports
in: query
description: ''
required: false
type: string
- name: module_bays
in: query
description: ''
required: false
type: string
- name: device_bays
in: query
description: ''
required: false
type: string
- name: primary_ip4_id
in: query
description: ''
required: false
type: string
- name: primary_ip6_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: asset_tag__n
in: query
description: ''
required: false
type: string
- name: asset_tag__ic
in: query
description: ''
required: false
type: string
- name: asset_tag__nic
in: query
description: ''
required: false
type: string
- name: asset_tag__iew
in: query
description: ''
required: false
type: string
- name: asset_tag__niew
in: query
description: ''
required: false
type: string
- name: asset_tag__isw
in: query
description: ''
required: false
type: string
- name: asset_tag__nisw
in: query
description: ''
required: false
type: string
- name: asset_tag__ie
in: query
description: ''
required: false
type: string
- name: asset_tag__nie
in: query
description: ''
required: false
type: string
- name: asset_tag__empty
in: query
description: ''
required: false
type: string
- name: face__n
in: query
description: ''
required: false
type: string
- name: position__n
in: query
description: ''
required: false
type: string
- name: position__lte
in: query
description: ''
required: false
type: string
- name: position__lt
in: query
description: ''
required: false
type: string
- name: position__gte
in: query
description: ''
required: false
type: string
- name: position__gt
in: query
description: ''
required: false
type: string
- name: airflow__n
in: query
description: ''
required: false
type: string
- name: vc_position__n
in: query
description: ''
required: false
type: string
- name: vc_position__lte
in: query
description: ''
required: false
type: string
- name: vc_position__lt
in: query
description: ''
required: false
type: string
- name: vc_position__gte
in: query
description: ''
required: false
type: string
- name: vc_position__gt
in: query
description: ''
required: false
type: string
- name: vc_priority__n
in: query
description: ''
required: false
type: string
- name: vc_priority__lte
in: query
description: ''
required: false
type: string
- name: vc_priority__lt
in: query
description: ''
required: false
type: string
- name: vc_priority__gte
in: query
description: ''
required: false
type: string
- name: vc_priority__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: device_type__n
in: query
description: ''
required: false
type: string
- name: device_type_id__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: parent_device_id__n
in: query
description: ''
required: false
type: string
- name: platform_id__n
in: query
description: ''
required: false
type: string
- name: platform__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: cluster_id__n
in: query
description: ''
required: false
type: string
- name: model__n
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: mac_address__n
in: query
description: ''
required: false
type: string
- name: mac_address__ic
in: query
description: ''
required: false
type: string
- name: mac_address__nic
in: query
description: ''
required: false
type: string
- name: mac_address__iew
in: query
description: ''
required: false
type: string
- name: mac_address__niew
in: query
description: ''
required: false
type: string
- name: mac_address__isw
in: query
description: ''
required: false
type: string
- name: mac_address__nisw
in: query
description: ''
required: false
type: string
- name: mac_address__ie
in: query
description: ''
required: false
type: string
- name: mac_address__nie
in: query
description: ''
required: false
type: string
- name: serial__n
in: query
description: ''
required: false
type: string
- name: serial__ic
in: query
description: ''
required: false
type: string
- name: serial__nic
in: query
description: ''
required: false
type: string
- name: serial__iew
in: query
description: ''
required: false
type: string
- name: serial__niew
in: query
description: ''
required: false
type: string
- name: serial__isw
in: query
description: ''
required: false
type: string
- name: serial__nisw
in: query
description: ''
required: false
type: string
- name: serial__ie
in: query
description: ''
required: false
type: string
- name: serial__nie
in: query
description: ''
required: false
type: string
- name: serial__empty
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: config_template_id__n
in: query
description: ''
required: false
type: string
- name: primary_ip4_id__n
in: query
description: ''
required: false
type: string
- name: primary_ip6_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
tags:
- dcim
post:
operationId: dcim_devices_create
description: ''
parameters: []
responses:
'201':
description: ''
tags:
- dcim
put:
operationId: dcim_devices_bulk_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- dcim
patch:
operationId: dcim_devices_bulk_partial_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- dcim
delete:
operationId: dcim_devices_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/devices/{id}/:
get:
operationId: dcim_devices_read
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- dcim
put:
operationId: dcim_devices_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- dcim
patch:
operationId: dcim_devices_partial_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- dcim
delete:
operationId: dcim_devices_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this device.
required: true
type: integer
/dcim/devices/{id}/render-config/:
post:
operationId: dcim_devices_render_config
description: Resolve and render the preferred ConfigTemplate for this Device.
parameters: []
responses:
'201':
description: ''
produces:
- application/json
- text/plain
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this device.
required: true
type: integer
/dcim/front-port-templates/:
get:
operationId: dcim_front-port-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
post:
operationId: dcim_front-port-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPortTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
put:
operationId: dcim_front-port-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
patch:
operationId: dcim_front-port-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
delete:
operationId: dcim_front-port-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/front-port-templates/{id}/:
get:
operationId: dcim_front-port-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
put:
operationId: dcim_front-port-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
patch:
operationId: dcim_front-port-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPortTemplate'
tags:
- dcim
delete:
operationId: dcim_front-port-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this front port template.
required: true
type: integer
/dcim/front-ports/:
get:
operationId: dcim_front-ports_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/FrontPort'
tags:
- dcim
post:
operationId: dcim_front-ports_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPort'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
put:
operationId: dcim_front-ports_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
patch:
operationId: dcim_front-ports_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
delete:
operationId: dcim_front-ports_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/front-ports/{id}/:
get:
operationId: dcim_front-ports_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
put:
operationId: dcim_front-ports_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
patch:
operationId: dcim_front-ports_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFrontPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
delete:
operationId: dcim_front-ports_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
type: integer
/dcim/front-ports/{id}/paths/:
get:
operationId: dcim_front-ports_paths
description: Return all CablePaths which traverse a given pass-through port.
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FrontPort'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this front port.
required: true
type: integer
/dcim/interface-templates/:
get:
operationId: dcim_interface-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: mgmt_only
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: bridge_id
in: query
description: ''
required: false
type: string
- name: poe_mode
in: query
description: ''
required: false
type: string
- name: poe_type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: bridge_id__n
in: query
description: ''
required: false
type: string
- name: poe_mode__n
in: query
description: ''
required: false
type: string
- name: poe_type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
post:
operationId: dcim_interface-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterfaceTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
put:
operationId: dcim_interface-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterfaceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
patch:
operationId: dcim_interface-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterfaceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
delete:
operationId: dcim_interface-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/interface-templates/{id}/:
get:
operationId: dcim_interface-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
put:
operationId: dcim_interface-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterfaceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
patch:
operationId: dcim_interface-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterfaceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InterfaceTemplate'
tags:
- dcim
delete:
operationId: dcim_interface-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this interface template.
required: true
type: integer
/dcim/interfaces/:
get:
operationId: dcim_interfaces_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: mtu
in: query
description: ''
required: false
type: string
- name: mgmt_only
in: query
description: ''
required: false
type: string
- name: poe_mode
in: query
description: ''
required: false
type: string
- name: poe_type
in: query
description: ''
required: false
type: string
- name: mode
in: query
description: ''
required: false
type: string
- name: rf_role
in: query
description: ''
required: false
type: string
- name: rf_channel
in: query
description: ''
required: false
type: string
- name: rf_channel_frequency
in: query
description: ''
required: false
type: string
- name: rf_channel_width
in: query
description: ''
required: false
type: string
- name: tx_power
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: connected
in: query
description: ''
required: false
type: string
- name: kind
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: bridge_id
in: query
description: ''
required: false
type: string
- name: lag_id
in: query
description: ''
required: false
type: string
- name: speed
in: query
description: ''
required: false
type: string
- name: duplex
in: query
description: ''
required: false
type: string
- name: mac_address
in: query
description: ''
required: false
type: string
- name: wwn
in: query
description: ''
required: false
type: string
- name: vlan_id
in: query
description: ''
required: false
type: string
- name: vlan
in: query
description: ''
required: false
type: string
- name: vrf_id
in: query
description: ''
required: false
type: string
- name: vrf
in: query
description: ''
required: false
type: string
- name: vdc_id
in: query
description: ''
required: false
type: string
- name: vdc_identifier
in: query
description: ''
required: false
type: string
- name: vdc
in: query
description: ''
required: false
type: string
- name: l2vpn_id
in: query
description: ''
required: false
type: string
- name: l2vpn
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: mtu__n
in: query
description: ''
required: false
type: string
- name: mtu__lte
in: query
description: ''
required: false
type: string
- name: mtu__lt
in: query
description: ''
required: false
type: string
- name: mtu__gte
in: query
description: ''
required: false
type: string
- name: mtu__gt
in: query
description: ''
required: false
type: string
- name: poe_mode__n
in: query
description: ''
required: false
type: string
- name: poe_type__n
in: query
description: ''
required: false
type: string
- name: mode__n
in: query
description: ''
required: false
type: string
- name: rf_role__n
in: query
description: ''
required: false
type: string
- name: rf_channel__n
in: query
description: ''
required: false
type: string
- name: rf_channel_frequency__n
in: query
description: ''
required: false
type: string
- name: rf_channel_frequency__lte
in: query
description: ''
required: false
type: string
- name: rf_channel_frequency__lt
in: query
description: ''
required: false
type: string
- name: rf_channel_frequency__gte
in: query
description: ''
required: false
type: string
- name: rf_channel_frequency__gt
in: query
description: ''
required: false
type: string
- name: rf_channel_width__n
in: query
description: ''
required: false
type: string
- name: rf_channel_width__lte
in: query
description: ''
required: false
type: string
- name: rf_channel_width__lt
in: query
description: ''
required: false
type: string
- name: rf_channel_width__gte
in: query
description: ''
required: false
type: string
- name: rf_channel_width__gt
in: query
description: ''
required: false
type: string
- name: tx_power__n
in: query
description: ''
required: false
type: string
- name: tx_power__lte
in: query
description: ''
required: false
type: string
- name: tx_power__lt
in: query
description: ''
required: false
type: string
- name: tx_power__gte
in: query
description: ''
required: false
type: string
- name: tx_power__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: bridge_id__n
in: query
description: ''
required: false
type: string
- name: lag_id__n
in: query
description: ''
required: false
type: string
- name: speed__n
in: query
description: ''
required: false
type: string
- name: speed__lte
in: query
description: ''
required: false
type: string
- name: speed__lt
in: query
description: ''
required: false
type: string
- name: speed__gte
in: query
description: ''
required: false
type: string
- name: speed__gt
in: query
description: ''
required: false
type: string
- name: duplex__n
in: query
description: ''
required: false
type: string
- name: mac_address__n
in: query
description: ''
required: false
type: string
- name: mac_address__ic
in: query
description: ''
required: false
type: string
- name: mac_address__nic
in: query
description: ''
required: false
type: string
- name: mac_address__iew
in: query
description: ''
required: false
type: string
- name: mac_address__niew
in: query
description: ''
required: false
type: string
- name: mac_address__isw
in: query
description: ''
required: false
type: string
- name: mac_address__nisw
in: query
description: ''
required: false
type: string
- name: mac_address__ie
in: query
description: ''
required: false
type: string
- name: mac_address__nie
in: query
description: ''
required: false
type: string
- name: wwn__n
in: query
description: ''
required: false
type: string
- name: wwn__ic
in: query
description: ''
required: false
type: string
- name: wwn__nic
in: query
description: ''
required: false
type: string
- name: wwn__iew
in: query
description: ''
required: false
type: string
- name: wwn__niew
in: query
description: ''
required: false
type: string
- name: wwn__isw
in: query
description: ''
required: false
type: string
- name: wwn__nisw
in: query
description: ''
required: false
type: string
- name: wwn__ie
in: query
description: ''
required: false
type: string
- name: wwn__nie
in: query
description: ''
required: false
type: string
- name: vrf_id__n
in: query
description: ''
required: false
type: string
- name: vrf__n
in: query
description: ''
required: false
type: string
- name: vdc_id__n
in: query
description: ''
required: false
type: string
- name: vdc_identifier__n
in: query
description: ''
required: false
type: string
- name: vdc__n
in: query
description: ''
required: false
type: string
- name: l2vpn_id__n
in: query
description: ''
required: false
type: string
- name: l2vpn__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Interface'
tags:
- dcim
post:
operationId: dcim_interfaces_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterface'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
put:
operationId: dcim_interfaces_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
patch:
operationId: dcim_interfaces_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
delete:
operationId: dcim_interfaces_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/interfaces/{id}/:
get:
operationId: dcim_interfaces_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
put:
operationId: dcim_interfaces_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
patch:
operationId: dcim_interfaces_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
delete:
operationId: dcim_interfaces_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
type: integer
/dcim/interfaces/{id}/trace/:
get:
operationId: dcim_interfaces_trace
description: Trace a complete cable path and return each segment as a three-tuple
of (termination, cable, termination).
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Interface'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
type: integer
/dcim/inventory-item-roles/:
get:
operationId: dcim_inventory-item-roles_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
post:
operationId: dcim_inventory-item-roles_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InventoryItemRole'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
put:
operationId: dcim_inventory-item-roles_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InventoryItemRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
patch:
operationId: dcim_inventory-item-roles_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InventoryItemRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
delete:
operationId: dcim_inventory-item-roles_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/inventory-item-roles/{id}/:
get:
operationId: dcim_inventory-item-roles_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
put:
operationId: dcim_inventory-item-roles_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InventoryItemRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
patch:
operationId: dcim_inventory-item-roles_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InventoryItemRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemRole'
tags:
- dcim
delete:
operationId: dcim_inventory-item-roles_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item role.
required: true
type: integer
/dcim/inventory-item-templates/:
get:
operationId: dcim_inventory-item-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: part_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: component_type
in: query
description: ''
required: false
type: string
- name: component_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: part_id__n
in: query
description: ''
required: false
type: string
- name: part_id__ic
in: query
description: ''
required: false
type: string
- name: part_id__nic
in: query
description: ''
required: false
type: string
- name: part_id__iew
in: query
description: ''
required: false
type: string
- name: part_id__niew
in: query
description: ''
required: false
type: string
- name: part_id__isw
in: query
description: ''
required: false
type: string
- name: part_id__nisw
in: query
description: ''
required: false
type: string
- name: part_id__ie
in: query
description: ''
required: false
type: string
- name: part_id__nie
in: query
description: ''
required: false
type: string
- name: part_id__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: component_type__n
in: query
description: ''
required: false
type: string
- name: component_id__n
in: query
description: ''
required: false
type: string
- name: component_id__lte
in: query
description: ''
required: false
type: string
- name: component_id__lt
in: query
description: ''
required: false
type: string
- name: component_id__gte
in: query
description: ''
required: false
type: string
- name: component_id__gt
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
post:
operationId: dcim_inventory-item-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItemTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
put:
operationId: dcim_inventory-item-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItemTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
patch:
operationId: dcim_inventory-item-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItemTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
delete:
operationId: dcim_inventory-item-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/inventory-item-templates/{id}/:
get:
operationId: dcim_inventory-item-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
put:
operationId: dcim_inventory-item-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItemTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
patch:
operationId: dcim_inventory-item-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItemTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItemTemplate'
tags:
- dcim
delete:
operationId: dcim_inventory-item-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item template.
required: true
type: integer
/dcim/inventory-items/:
get:
operationId: dcim_inventory-items_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: part_id
in: query
description: ''
required: false
type: string
- name: asset_tag
in: query
description: ''
required: false
type: string
- name: discovered
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: component_type
in: query
description: ''
required: false
type: string
- name: component_id
in: query
description: ''
required: false
type: string
- name: serial
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: part_id__n
in: query
description: ''
required: false
type: string
- name: part_id__ic
in: query
description: ''
required: false
type: string
- name: part_id__nic
in: query
description: ''
required: false
type: string
- name: part_id__iew
in: query
description: ''
required: false
type: string
- name: part_id__niew
in: query
description: ''
required: false
type: string
- name: part_id__isw
in: query
description: ''
required: false
type: string
- name: part_id__nisw
in: query
description: ''
required: false
type: string
- name: part_id__ie
in: query
description: ''
required: false
type: string
- name: part_id__nie
in: query
description: ''
required: false
type: string
- name: part_id__empty
in: query
description: ''
required: false
type: string
- name: asset_tag__n
in: query
description: ''
required: false
type: string
- name: asset_tag__ic
in: query
description: ''
required: false
type: string
- name: asset_tag__nic
in: query
description: ''
required: false
type: string
- name: asset_tag__iew
in: query
description: ''
required: false
type: string
- name: asset_tag__niew
in: query
description: ''
required: false
type: string
- name: asset_tag__isw
in: query
description: ''
required: false
type: string
- name: asset_tag__nisw
in: query
description: ''
required: false
type: string
- name: asset_tag__ie
in: query
description: ''
required: false
type: string
- name: asset_tag__nie
in: query
description: ''
required: false
type: string
- name: asset_tag__empty
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: component_type__n
in: query
description: ''
required: false
type: string
- name: component_id__n
in: query
description: ''
required: false
type: string
- name: component_id__lte
in: query
description: ''
required: false
type: string
- name: component_id__lt
in: query
description: ''
required: false
type: string
- name: component_id__gte
in: query
description: ''
required: false
type: string
- name: component_id__gt
in: query
description: ''
required: false
type: string
- name: serial__n
in: query
description: ''
required: false
type: string
- name: serial__ic
in: query
description: ''
required: false
type: string
- name: serial__nic
in: query
description: ''
required: false
type: string
- name: serial__iew
in: query
description: ''
required: false
type: string
- name: serial__niew
in: query
description: ''
required: false
type: string
- name: serial__isw
in: query
description: ''
required: false
type: string
- name: serial__nisw
in: query
description: ''
required: false
type: string
- name: serial__ie
in: query
description: ''
required: false
type: string
- name: serial__nie
in: query
description: ''
required: false
type: string
- name: serial__empty
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
post:
operationId: dcim_inventory-items_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItem'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
put:
operationId: dcim_inventory-items_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItem'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
patch:
operationId: dcim_inventory-items_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItem'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
delete:
operationId: dcim_inventory-items_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/inventory-items/{id}/:
get:
operationId: dcim_inventory-items_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
put:
operationId: dcim_inventory-items_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItem'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
patch:
operationId: dcim_inventory-items_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableInventoryItem'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InventoryItem'
tags:
- dcim
delete:
operationId: dcim_inventory-items_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this inventory item.
required: true
type: integer
/dcim/locations/:
get:
operationId: dcim_locations_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: parent
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: parent__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Location'
tags:
- dcim
post:
operationId: dcim_locations_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableLocation'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Location'
tags:
- dcim
put:
operationId: dcim_locations_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableLocation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Location'
tags:
- dcim
patch:
operationId: dcim_locations_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableLocation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Location'
tags:
- dcim
delete:
operationId: dcim_locations_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/locations/{id}/:
get:
operationId: dcim_locations_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Location'
tags:
- dcim
put:
operationId: dcim_locations_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableLocation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Location'
tags:
- dcim
patch:
operationId: dcim_locations_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableLocation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Location'
tags:
- dcim
delete:
operationId: dcim_locations_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this location.
required: true
type: integer
/dcim/manufacturers/:
get:
operationId: dcim_manufacturers_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
post:
operationId: dcim_manufacturers_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Manufacturer'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
put:
operationId: dcim_manufacturers_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Manufacturer'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
patch:
operationId: dcim_manufacturers_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Manufacturer'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
delete:
operationId: dcim_manufacturers_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/manufacturers/{id}/:
get:
operationId: dcim_manufacturers_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
put:
operationId: dcim_manufacturers_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Manufacturer'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
patch:
operationId: dcim_manufacturers_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Manufacturer'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Manufacturer'
tags:
- dcim
delete:
operationId: dcim_manufacturers_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this manufacturer.
required: true
type: integer
/dcim/module-bay-templates/:
get:
operationId: dcim_module-bay-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
post:
operationId: dcim_module-bay-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBayTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
put:
operationId: dcim_module-bay-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
patch:
operationId: dcim_module-bay-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
delete:
operationId: dcim_module-bay-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/module-bay-templates/{id}/:
get:
operationId: dcim_module-bay-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
put:
operationId: dcim_module-bay-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
patch:
operationId: dcim_module-bay-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBayTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBayTemplate'
tags:
- dcim
delete:
operationId: dcim_module-bay-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this module bay template.
required: true
type: integer
/dcim/module-bays/:
get:
operationId: dcim_module-bays_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
post:
operationId: dcim_module-bays_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBay'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
put:
operationId: dcim_module-bays_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
patch:
operationId: dcim_module-bays_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
delete:
operationId: dcim_module-bays_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/module-bays/{id}/:
get:
operationId: dcim_module-bays_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
put:
operationId: dcim_module-bays_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
patch:
operationId: dcim_module-bays_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleBay'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleBay'
tags:
- dcim
delete:
operationId: dcim_module-bays_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this module bay.
required: true
type: integer
/dcim/module-types/:
get:
operationId: dcim_module-types_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: model
in: query
description: ''
required: false
type: string
- name: part_number
in: query
description: ''
required: false
type: string
- name: weight
in: query
description: ''
required: false
type: string
- name: weight_unit
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: console_ports
in: query
description: ''
required: false
type: string
- name: console_server_ports
in: query
description: ''
required: false
type: string
- name: power_ports
in: query
description: ''
required: false
type: string
- name: power_outlets
in: query
description: ''
required: false
type: string
- name: interfaces
in: query
description: ''
required: false
type: string
- name: pass_through_ports
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: model__n
in: query
description: ''
required: false
type: string
- name: model__ic
in: query
description: ''
required: false
type: string
- name: model__nic
in: query
description: ''
required: false
type: string
- name: model__iew
in: query
description: ''
required: false
type: string
- name: model__niew
in: query
description: ''
required: false
type: string
- name: model__isw
in: query
description: ''
required: false
type: string
- name: model__nisw
in: query
description: ''
required: false
type: string
- name: model__ie
in: query
description: ''
required: false
type: string
- name: model__nie
in: query
description: ''
required: false
type: string
- name: model__empty
in: query
description: ''
required: false
type: string
- name: part_number__n
in: query
description: ''
required: false
type: string
- name: part_number__ic
in: query
description: ''
required: false
type: string
- name: part_number__nic
in: query
description: ''
required: false
type: string
- name: part_number__iew
in: query
description: ''
required: false
type: string
- name: part_number__niew
in: query
description: ''
required: false
type: string
- name: part_number__isw
in: query
description: ''
required: false
type: string
- name: part_number__nisw
in: query
description: ''
required: false
type: string
- name: part_number__ie
in: query
description: ''
required: false
type: string
- name: part_number__nie
in: query
description: ''
required: false
type: string
- name: part_number__empty
in: query
description: ''
required: false
type: string
- name: weight__n
in: query
description: ''
required: false
type: string
- name: weight__lte
in: query
description: ''
required: false
type: string
- name: weight__lt
in: query
description: ''
required: false
type: string
- name: weight__gte
in: query
description: ''
required: false
type: string
- name: weight__gt
in: query
description: ''
required: false
type: string
- name: weight_unit__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ModuleType'
tags:
- dcim
post:
operationId: dcim_module-types_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleType'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ModuleType'
tags:
- dcim
put:
operationId: dcim_module-types_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleType'
tags:
- dcim
patch:
operationId: dcim_module-types_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleType'
tags:
- dcim
delete:
operationId: dcim_module-types_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/module-types/{id}/:
get:
operationId: dcim_module-types_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleType'
tags:
- dcim
put:
operationId: dcim_module-types_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleType'
tags:
- dcim
patch:
operationId: dcim_module-types_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModuleType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ModuleType'
tags:
- dcim
delete:
operationId: dcim_module-types_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this module type.
required: true
type: integer
/dcim/modules/:
get:
operationId: dcim_modules_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: asset_tag
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: module_type_id
in: query
description: ''
required: false
type: string
- name: module_type
in: query
description: ''
required: false
type: string
- name: module_bay_id
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: serial
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: asset_tag__n
in: query
description: ''
required: false
type: string
- name: asset_tag__ic
in: query
description: ''
required: false
type: string
- name: asset_tag__nic
in: query
description: ''
required: false
type: string
- name: asset_tag__iew
in: query
description: ''
required: false
type: string
- name: asset_tag__niew
in: query
description: ''
required: false
type: string
- name: asset_tag__isw
in: query
description: ''
required: false
type: string
- name: asset_tag__nisw
in: query
description: ''
required: false
type: string
- name: asset_tag__ie
in: query
description: ''
required: false
type: string
- name: asset_tag__nie
in: query
description: ''
required: false
type: string
- name: asset_tag__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: module_type_id__n
in: query
description: ''
required: false
type: string
- name: module_type__n
in: query
description: ''
required: false
type: string
- name: module_bay_id__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: serial__n
in: query
description: ''
required: false
type: string
- name: serial__ic
in: query
description: ''
required: false
type: string
- name: serial__nic
in: query
description: ''
required: false
type: string
- name: serial__iew
in: query
description: ''
required: false
type: string
- name: serial__niew
in: query
description: ''
required: false
type: string
- name: serial__isw
in: query
description: ''
required: false
type: string
- name: serial__nisw
in: query
description: ''
required: false
type: string
- name: serial__ie
in: query
description: ''
required: false
type: string
- name: serial__nie
in: query
description: ''
required: false
type: string
- name: serial__empty
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Module'
tags:
- dcim
post:
operationId: dcim_modules_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModule'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Module'
tags:
- dcim
put:
operationId: dcim_modules_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModule'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Module'
tags:
- dcim
patch:
operationId: dcim_modules_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModule'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Module'
tags:
- dcim
delete:
operationId: dcim_modules_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/modules/{id}/:
get:
operationId: dcim_modules_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Module'
tags:
- dcim
put:
operationId: dcim_modules_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModule'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Module'
tags:
- dcim
patch:
operationId: dcim_modules_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableModule'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Module'
tags:
- dcim
delete:
operationId: dcim_modules_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this module.
required: true
type: integer
/dcim/platforms/:
get:
operationId: dcim_platforms_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: manufacturer_id
in: query
description: ''
required: false
type: string
- name: manufacturer
in: query
description: ''
required: false
type: string
- name: config_template_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: manufacturer_id__n
in: query
description: ''
required: false
type: string
- name: manufacturer__n
in: query
description: ''
required: false
type: string
- name: config_template_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Platform'
tags:
- dcim
post:
operationId: dcim_platforms_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePlatform'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Platform'
tags:
- dcim
put:
operationId: dcim_platforms_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePlatform'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Platform'
tags:
- dcim
patch:
operationId: dcim_platforms_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePlatform'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Platform'
tags:
- dcim
delete:
operationId: dcim_platforms_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/platforms/{id}/:
get:
operationId: dcim_platforms_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Platform'
tags:
- dcim
put:
operationId: dcim_platforms_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePlatform'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Platform'
tags:
- dcim
patch:
operationId: dcim_platforms_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePlatform'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Platform'
tags:
- dcim
delete:
operationId: dcim_platforms_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this platform.
required: true
type: integer
/dcim/power-feeds/:
get:
operationId: dcim_power-feeds_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: supply
in: query
description: ''
required: false
type: string
- name: phase
in: query
description: ''
required: false
type: string
- name: voltage
in: query
description: ''
required: false
type: string
- name: amperage
in: query
description: ''
required: false
type: string
- name: max_utilization
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: connected
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: power_panel_id
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: supply__n
in: query
description: ''
required: false
type: string
- name: phase__n
in: query
description: ''
required: false
type: string
- name: voltage__n
in: query
description: ''
required: false
type: string
- name: voltage__lte
in: query
description: ''
required: false
type: string
- name: voltage__lt
in: query
description: ''
required: false
type: string
- name: voltage__gte
in: query
description: ''
required: false
type: string
- name: voltage__gt
in: query
description: ''
required: false
type: string
- name: amperage__n
in: query
description: ''
required: false
type: string
- name: amperage__lte
in: query
description: ''
required: false
type: string
- name: amperage__lt
in: query
description: ''
required: false
type: string
- name: amperage__gte
in: query
description: ''
required: false
type: string
- name: amperage__gt
in: query
description: ''
required: false
type: string
- name: max_utilization__n
in: query
description: ''
required: false
type: string
- name: max_utilization__lte
in: query
description: ''
required: false
type: string
- name: max_utilization__lt
in: query
description: ''
required: false
type: string
- name: max_utilization__gte
in: query
description: ''
required: false
type: string
- name: max_utilization__gt
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: power_panel_id__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
post:
operationId: dcim_power-feeds_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerFeed'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
put:
operationId: dcim_power-feeds_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerFeed'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
patch:
operationId: dcim_power-feeds_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerFeed'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
delete:
operationId: dcim_power-feeds_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/power-feeds/{id}/:
get:
operationId: dcim_power-feeds_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
put:
operationId: dcim_power-feeds_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerFeed'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
patch:
operationId: dcim_power-feeds_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerFeed'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
delete:
operationId: dcim_power-feeds_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
type: integer
/dcim/power-feeds/{id}/trace/:
get:
operationId: dcim_power-feeds_trace
description: Trace a complete cable path and return each segment as a three-tuple
of (termination, cable, termination).
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerFeed'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power feed.
required: true
type: integer
/dcim/power-outlet-templates/:
get:
operationId: dcim_power-outlet-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: feed_leg
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: feed_leg__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
post:
operationId: dcim_power-outlet-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutletTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
put:
operationId: dcim_power-outlet-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutletTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
patch:
operationId: dcim_power-outlet-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutletTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
delete:
operationId: dcim_power-outlet-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/power-outlet-templates/{id}/:
get:
operationId: dcim_power-outlet-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
put:
operationId: dcim_power-outlet-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutletTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
patch:
operationId: dcim_power-outlet-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutletTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutletTemplate'
tags:
- dcim
delete:
operationId: dcim_power-outlet-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet template.
required: true
type: integer
/dcim/power-outlets/:
get:
operationId: dcim_power-outlets_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: feed_leg
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: connected
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: feed_leg__n
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
post:
operationId: dcim_power-outlets_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutlet'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
put:
operationId: dcim_power-outlets_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutlet'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
patch:
operationId: dcim_power-outlets_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutlet'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
delete:
operationId: dcim_power-outlets_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/power-outlets/{id}/:
get:
operationId: dcim_power-outlets_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
put:
operationId: dcim_power-outlets_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutlet'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
patch:
operationId: dcim_power-outlets_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerOutlet'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
delete:
operationId: dcim_power-outlets_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
type: integer
/dcim/power-outlets/{id}/trace/:
get:
operationId: dcim_power-outlets_trace
description: Trace a complete cable path and return each segment as a three-tuple
of (termination, cable, termination).
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerOutlet'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power outlet.
required: true
type: integer
/dcim/power-panels/:
get:
operationId: dcim_power-panels_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
post:
operationId: dcim_power-panels_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPanel'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
put:
operationId: dcim_power-panels_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPanel'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
patch:
operationId: dcim_power-panels_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPanel'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
delete:
operationId: dcim_power-panels_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/power-panels/{id}/:
get:
operationId: dcim_power-panels_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
put:
operationId: dcim_power-panels_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPanel'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
patch:
operationId: dcim_power-panels_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPanel'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPanel'
tags:
- dcim
delete:
operationId: dcim_power-panels_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power panel.
required: true
type: integer
/dcim/power-port-templates/:
get:
operationId: dcim_power-port-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: maximum_draw
in: query
description: ''
required: false
type: string
- name: allocated_draw
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: maximum_draw__n
in: query
description: ''
required: false
type: string
- name: maximum_draw__lte
in: query
description: ''
required: false
type: string
- name: maximum_draw__lt
in: query
description: ''
required: false
type: string
- name: maximum_draw__gte
in: query
description: ''
required: false
type: string
- name: maximum_draw__gt
in: query
description: ''
required: false
type: string
- name: allocated_draw__n
in: query
description: ''
required: false
type: string
- name: allocated_draw__lte
in: query
description: ''
required: false
type: string
- name: allocated_draw__lt
in: query
description: ''
required: false
type: string
- name: allocated_draw__gte
in: query
description: ''
required: false
type: string
- name: allocated_draw__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
post:
operationId: dcim_power-port-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPortTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
put:
operationId: dcim_power-port-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
patch:
operationId: dcim_power-port-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
delete:
operationId: dcim_power-port-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/power-port-templates/{id}/:
get:
operationId: dcim_power-port-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
put:
operationId: dcim_power-port-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
patch:
operationId: dcim_power-port-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPortTemplate'
tags:
- dcim
delete:
operationId: dcim_power-port-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power port template.
required: true
type: integer
/dcim/power-ports/:
get:
operationId: dcim_power-ports_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: maximum_draw
in: query
description: ''
required: false
type: string
- name: allocated_draw
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: connected
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: maximum_draw__n
in: query
description: ''
required: false
type: string
- name: maximum_draw__lte
in: query
description: ''
required: false
type: string
- name: maximum_draw__lt
in: query
description: ''
required: false
type: string
- name: maximum_draw__gte
in: query
description: ''
required: false
type: string
- name: maximum_draw__gt
in: query
description: ''
required: false
type: string
- name: allocated_draw__n
in: query
description: ''
required: false
type: string
- name: allocated_draw__lte
in: query
description: ''
required: false
type: string
- name: allocated_draw__lt
in: query
description: ''
required: false
type: string
- name: allocated_draw__gte
in: query
description: ''
required: false
type: string
- name: allocated_draw__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PowerPort'
tags:
- dcim
post:
operationId: dcim_power-ports_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPort'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
put:
operationId: dcim_power-ports_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
patch:
operationId: dcim_power-ports_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
delete:
operationId: dcim_power-ports_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/power-ports/{id}/:
get:
operationId: dcim_power-ports_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
put:
operationId: dcim_power-ports_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
patch:
operationId: dcim_power-ports_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePowerPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
delete:
operationId: dcim_power-ports_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
type: integer
/dcim/power-ports/{id}/trace/:
get:
operationId: dcim_power-ports_trace
description: Trace a complete cable path and return each segment as a three-tuple
of (termination, cable, termination).
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PowerPort'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this power port.
required: true
type: integer
/dcim/rack-reservations/:
get:
operationId: dcim_rack-reservations_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: user_id
in: query
description: ''
required: false
type: string
- name: user
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: user_id__n
in: query
description: ''
required: false
type: string
- name: user__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/RackReservation'
tags:
- dcim
post:
operationId: dcim_rack-reservations_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRackReservation'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/RackReservation'
tags:
- dcim
put:
operationId: dcim_rack-reservations_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRackReservation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackReservation'
tags:
- dcim
patch:
operationId: dcim_rack-reservations_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRackReservation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackReservation'
tags:
- dcim
delete:
operationId: dcim_rack-reservations_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/rack-reservations/{id}/:
get:
operationId: dcim_rack-reservations_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackReservation'
tags:
- dcim
put:
operationId: dcim_rack-reservations_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRackReservation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackReservation'
tags:
- dcim
patch:
operationId: dcim_rack-reservations_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRackReservation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackReservation'
tags:
- dcim
delete:
operationId: dcim_rack-reservations_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rack reservation.
required: true
type: integer
/dcim/rack-roles/:
get:
operationId: dcim_rack-roles_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/RackRole'
tags:
- dcim
post:
operationId: dcim_rack-roles_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RackRole'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/RackRole'
tags:
- dcim
put:
operationId: dcim_rack-roles_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RackRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackRole'
tags:
- dcim
patch:
operationId: dcim_rack-roles_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RackRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackRole'
tags:
- dcim
delete:
operationId: dcim_rack-roles_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/rack-roles/{id}/:
get:
operationId: dcim_rack-roles_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackRole'
tags:
- dcim
put:
operationId: dcim_rack-roles_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RackRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackRole'
tags:
- dcim
patch:
operationId: dcim_rack-roles_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RackRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RackRole'
tags:
- dcim
delete:
operationId: dcim_rack-roles_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rack role.
required: true
type: integer
/dcim/racks/:
get:
operationId: dcim_racks_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: facility_id
in: query
description: ''
required: false
type: string
- name: asset_tag
in: query
description: ''
required: false
type: string
- name: u_height
in: query
description: ''
required: false
type: string
- name: desc_units
in: query
description: ''
required: false
type: string
- name: outer_width
in: query
description: ''
required: false
type: string
- name: outer_depth
in: query
description: ''
required: false
type: string
- name: outer_unit
in: query
description: ''
required: false
type: string
- name: mounting_depth
in: query
description: ''
required: false
type: string
- name: weight
in: query
description: ''
required: false
type: string
- name: max_weight
in: query
description: ''
required: false
type: string
- name: weight_unit
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: width
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: serial
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: facility_id__n
in: query
description: ''
required: false
type: string
- name: facility_id__ic
in: query
description: ''
required: false
type: string
- name: facility_id__nic
in: query
description: ''
required: false
type: string
- name: facility_id__iew
in: query
description: ''
required: false
type: string
- name: facility_id__niew
in: query
description: ''
required: false
type: string
- name: facility_id__isw
in: query
description: ''
required: false
type: string
- name: facility_id__nisw
in: query
description: ''
required: false
type: string
- name: facility_id__ie
in: query
description: ''
required: false
type: string
- name: facility_id__nie
in: query
description: ''
required: false
type: string
- name: facility_id__empty
in: query
description: ''
required: false
type: string
- name: asset_tag__n
in: query
description: ''
required: false
type: string
- name: asset_tag__ic
in: query
description: ''
required: false
type: string
- name: asset_tag__nic
in: query
description: ''
required: false
type: string
- name: asset_tag__iew
in: query
description: ''
required: false
type: string
- name: asset_tag__niew
in: query
description: ''
required: false
type: string
- name: asset_tag__isw
in: query
description: ''
required: false
type: string
- name: asset_tag__nisw
in: query
description: ''
required: false
type: string
- name: asset_tag__ie
in: query
description: ''
required: false
type: string
- name: asset_tag__nie
in: query
description: ''
required: false
type: string
- name: asset_tag__empty
in: query
description: ''
required: false
type: string
- name: u_height__n
in: query
description: ''
required: false
type: string
- name: u_height__lte
in: query
description: ''
required: false
type: string
- name: u_height__lt
in: query
description: ''
required: false
type: string
- name: u_height__gte
in: query
description: ''
required: false
type: string
- name: u_height__gt
in: query
description: ''
required: false
type: string
- name: outer_width__n
in: query
description: ''
required: false
type: string
- name: outer_width__lte
in: query
description: ''
required: false
type: string
- name: outer_width__lt
in: query
description: ''
required: false
type: string
- name: outer_width__gte
in: query
description: ''
required: false
type: string
- name: outer_width__gt
in: query
description: ''
required: false
type: string
- name: outer_depth__n
in: query
description: ''
required: false
type: string
- name: outer_depth__lte
in: query
description: ''
required: false
type: string
- name: outer_depth__lt
in: query
description: ''
required: false
type: string
- name: outer_depth__gte
in: query
description: ''
required: false
type: string
- name: outer_depth__gt
in: query
description: ''
required: false
type: string
- name: outer_unit__n
in: query
description: ''
required: false
type: string
- name: mounting_depth__n
in: query
description: ''
required: false
type: string
- name: mounting_depth__lte
in: query
description: ''
required: false
type: string
- name: mounting_depth__lt
in: query
description: ''
required: false
type: string
- name: mounting_depth__gte
in: query
description: ''
required: false
type: string
- name: mounting_depth__gt
in: query
description: ''
required: false
type: string
- name: weight__n
in: query
description: ''
required: false
type: string
- name: weight__lte
in: query
description: ''
required: false
type: string
- name: weight__lt
in: query
description: ''
required: false
type: string
- name: weight__gte
in: query
description: ''
required: false
type: string
- name: weight__gt
in: query
description: ''
required: false
type: string
- name: max_weight__n
in: query
description: ''
required: false
type: string
- name: max_weight__lte
in: query
description: ''
required: false
type: string
- name: max_weight__lt
in: query
description: ''
required: false
type: string
- name: max_weight__gte
in: query
description: ''
required: false
type: string
- name: max_weight__gt
in: query
description: ''
required: false
type: string
- name: weight_unit__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: width__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: serial__n
in: query
description: ''
required: false
type: string
- name: serial__ic
in: query
description: ''
required: false
type: string
- name: serial__nic
in: query
description: ''
required: false
type: string
- name: serial__iew
in: query
description: ''
required: false
type: string
- name: serial__niew
in: query
description: ''
required: false
type: string
- name: serial__isw
in: query
description: ''
required: false
type: string
- name: serial__nisw
in: query
description: ''
required: false
type: string
- name: serial__ie
in: query
description: ''
required: false
type: string
- name: serial__nie
in: query
description: ''
required: false
type: string
- name: serial__empty
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Rack'
tags:
- dcim
post:
operationId: dcim_racks_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRack'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Rack'
tags:
- dcim
put:
operationId: dcim_racks_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRack'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Rack'
tags:
- dcim
patch:
operationId: dcim_racks_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRack'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Rack'
tags:
- dcim
delete:
operationId: dcim_racks_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/racks/{id}/:
get:
operationId: dcim_racks_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Rack'
tags:
- dcim
put:
operationId: dcim_racks_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRack'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Rack'
tags:
- dcim
patch:
operationId: dcim_racks_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRack'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Rack'
tags:
- dcim
delete:
operationId: dcim_racks_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
type: integer
/dcim/racks/{id}/elevation/:
get:
operationId: dcim_racks_elevation
description: Rack elevation representing the list of rack units. Also supports
rendering the elevation as an SVG.
parameters:
- name: q
in: query
required: false
type: string
minLength: 1
- name: face
in: query
required: false
type: string
enum:
- front
- rear
default: front
- name: render
in: query
required: false
type: string
enum:
- json
- svg
default: json
- name: unit_width
in: query
required: false
type: integer
default: 220
- name: unit_height
in: query
required: false
type: integer
default: 22
- name: legend_width
in: query
required: false
type: integer
default: 30
- name: margin_width
in: query
required: false
type: integer
default: 15
- name: exclude
in: query
required: false
type: integer
- name: expand_devices
in: query
required: false
type: boolean
default: true
- name: include_images
in: query
required: false
type: boolean
default: true
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/RackUnit'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rack.
required: true
type: integer
/dcim/rear-port-templates/:
get:
operationId: dcim_rear-port-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: positions
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: devicetype_id
in: query
description: ''
required: false
type: string
- name: moduletype_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: positions__n
in: query
description: ''
required: false
type: string
- name: positions__lte
in: query
description: ''
required: false
type: string
- name: positions__lt
in: query
description: ''
required: false
type: string
- name: positions__gte
in: query
description: ''
required: false
type: string
- name: positions__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: devicetype_id__n
in: query
description: ''
required: false
type: string
- name: moduletype_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
post:
operationId: dcim_rear-port-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPortTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
put:
operationId: dcim_rear-port-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
patch:
operationId: dcim_rear-port-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
delete:
operationId: dcim_rear-port-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/rear-port-templates/{id}/:
get:
operationId: dcim_rear-port-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
put:
operationId: dcim_rear-port-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
patch:
operationId: dcim_rear-port-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPortTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPortTemplate'
tags:
- dcim
delete:
operationId: dcim_rear-port-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port template.
required: true
type: integer
/dcim/rear-ports/:
get:
operationId: dcim_rear-ports_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: label
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: positions
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: cable_end
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: rack_id
in: query
description: ''
required: false
type: string
- name: rack
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id
in: query
description: ''
required: false
type: string
- name: virtual_chassis
in: query
description: ''
required: false
type: string
- name: module_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cabled
in: query
description: ''
required: false
type: string
- name: occupied
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: label__n
in: query
description: ''
required: false
type: string
- name: label__ic
in: query
description: ''
required: false
type: string
- name: label__nic
in: query
description: ''
required: false
type: string
- name: label__iew
in: query
description: ''
required: false
type: string
- name: label__niew
in: query
description: ''
required: false
type: string
- name: label__isw
in: query
description: ''
required: false
type: string
- name: label__nisw
in: query
description: ''
required: false
type: string
- name: label__ie
in: query
description: ''
required: false
type: string
- name: label__nie
in: query
description: ''
required: false
type: string
- name: label__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: positions__n
in: query
description: ''
required: false
type: string
- name: positions__lte
in: query
description: ''
required: false
type: string
- name: positions__lt
in: query
description: ''
required: false
type: string
- name: positions__gte
in: query
description: ''
required: false
type: string
- name: positions__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: cable_end__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: rack_id__n
in: query
description: ''
required: false
type: string
- name: rack__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis_id__n
in: query
description: ''
required: false
type: string
- name: virtual_chassis__n
in: query
description: ''
required: false
type: string
- name: module_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/RearPort'
tags:
- dcim
post:
operationId: dcim_rear-ports_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPort'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
put:
operationId: dcim_rear-ports_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
patch:
operationId: dcim_rear-ports_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
delete:
operationId: dcim_rear-ports_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/rear-ports/{id}/:
get:
operationId: dcim_rear-ports_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
put:
operationId: dcim_rear-ports_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
patch:
operationId: dcim_rear-ports_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRearPort'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
delete:
operationId: dcim_rear-ports_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
type: integer
/dcim/rear-ports/{id}/paths/:
get:
operationId: dcim_rear-ports_paths
description: Return all CablePaths which traverse a given pass-through port.
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RearPort'
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this rear port.
required: true
type: integer
/dcim/regions/:
get:
operationId: dcim_regions_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: parent
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: parent__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Region'
tags:
- dcim
post:
operationId: dcim_regions_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRegion'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Region'
tags:
- dcim
put:
operationId: dcim_regions_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRegion'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Region'
tags:
- dcim
patch:
operationId: dcim_regions_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRegion'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Region'
tags:
- dcim
delete:
operationId: dcim_regions_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/regions/{id}/:
get:
operationId: dcim_regions_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Region'
tags:
- dcim
put:
operationId: dcim_regions_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRegion'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Region'
tags:
- dcim
patch:
operationId: dcim_regions_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRegion'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Region'
tags:
- dcim
delete:
operationId: dcim_regions_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this region.
required: true
type: integer
/dcim/site-groups/:
get:
operationId: dcim_site-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: parent
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: parent__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
post:
operationId: dcim_site-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSiteGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
put:
operationId: dcim_site-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSiteGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
patch:
operationId: dcim_site-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSiteGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
delete:
operationId: dcim_site-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/site-groups/{id}/:
get:
operationId: dcim_site-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
put:
operationId: dcim_site-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSiteGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
patch:
operationId: dcim_site-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSiteGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SiteGroup'
tags:
- dcim
delete:
operationId: dcim_site-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this site group.
required: true
type: integer
/dcim/sites/:
get:
operationId: dcim_sites_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: facility
in: query
description: ''
required: false
type: string
- name: latitude
in: query
description: ''
required: false
type: string
- name: longitude
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: asn
in: query
description: ''
required: false
type: string
- name: asn_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: facility__n
in: query
description: ''
required: false
type: string
- name: facility__ic
in: query
description: ''
required: false
type: string
- name: facility__nic
in: query
description: ''
required: false
type: string
- name: facility__iew
in: query
description: ''
required: false
type: string
- name: facility__niew
in: query
description: ''
required: false
type: string
- name: facility__isw
in: query
description: ''
required: false
type: string
- name: facility__nisw
in: query
description: ''
required: false
type: string
- name: facility__ie
in: query
description: ''
required: false
type: string
- name: facility__nie
in: query
description: ''
required: false
type: string
- name: facility__empty
in: query
description: ''
required: false
type: string
- name: latitude__n
in: query
description: ''
required: false
type: string
- name: latitude__lte
in: query
description: ''
required: false
type: string
- name: latitude__lt
in: query
description: ''
required: false
type: string
- name: latitude__gte
in: query
description: ''
required: false
type: string
- name: latitude__gt
in: query
description: ''
required: false
type: string
- name: longitude__n
in: query
description: ''
required: false
type: string
- name: longitude__lte
in: query
description: ''
required: false
type: string
- name: longitude__lt
in: query
description: ''
required: false
type: string
- name: longitude__gte
in: query
description: ''
required: false
type: string
- name: longitude__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: asn__n
in: query
description: ''
required: false
type: string
- name: asn_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Site'
tags:
- dcim
post:
operationId: dcim_sites_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSite'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Site'
tags:
- dcim
put:
operationId: dcim_sites_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSite'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Site'
tags:
- dcim
patch:
operationId: dcim_sites_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSite'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Site'
tags:
- dcim
delete:
operationId: dcim_sites_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/sites/{id}/:
get:
operationId: dcim_sites_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Site'
tags:
- dcim
put:
operationId: dcim_sites_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSite'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Site'
tags:
- dcim
patch:
operationId: dcim_sites_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableSite'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Site'
tags:
- dcim
delete:
operationId: dcim_sites_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this site.
required: true
type: integer
/dcim/virtual-chassis/:
get:
operationId: dcim_virtual-chassis_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: domain
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: master_id
in: query
description: ''
required: false
type: string
- name: master
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: domain__n
in: query
description: ''
required: false
type: string
- name: domain__ic
in: query
description: ''
required: false
type: string
- name: domain__nic
in: query
description: ''
required: false
type: string
- name: domain__iew
in: query
description: ''
required: false
type: string
- name: domain__niew
in: query
description: ''
required: false
type: string
- name: domain__isw
in: query
description: ''
required: false
type: string
- name: domain__nisw
in: query
description: ''
required: false
type: string
- name: domain__ie
in: query
description: ''
required: false
type: string
- name: domain__nie
in: query
description: ''
required: false
type: string
- name: domain__empty
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: master_id__n
in: query
description: ''
required: false
type: string
- name: master__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
post:
operationId: dcim_virtual-chassis_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualChassis'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
put:
operationId: dcim_virtual-chassis_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualChassis'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
patch:
operationId: dcim_virtual-chassis_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualChassis'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
delete:
operationId: dcim_virtual-chassis_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/virtual-chassis/{id}/:
get:
operationId: dcim_virtual-chassis_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
put:
operationId: dcim_virtual-chassis_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualChassis'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
patch:
operationId: dcim_virtual-chassis_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualChassis'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualChassis'
tags:
- dcim
delete:
operationId: dcim_virtual-chassis_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual chassis.
required: true
type: integer
/dcim/virtual-device-contexts/:
get:
operationId: dcim_virtual-device-contexts_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: has_primary_ip
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
post:
operationId: dcim_virtual-device-contexts_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualDeviceContext'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
put:
operationId: dcim_virtual-device-contexts_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualDeviceContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
patch:
operationId: dcim_virtual-device-contexts_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualDeviceContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
delete:
operationId: dcim_virtual-device-contexts_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters: []
/dcim/virtual-device-contexts/{id}/:
get:
operationId: dcim_virtual-device-contexts_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
put:
operationId: dcim_virtual-device-contexts_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualDeviceContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
patch:
operationId: dcim_virtual-device-contexts_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVirtualDeviceContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VirtualDeviceContext'
tags:
- dcim
delete:
operationId: dcim_virtual-device-contexts_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- dcim
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual device context.
required: true
type: integer
/extras/config-contexts/:
get:
operationId: extras_config-contexts_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: is_active
in: query
description: ''
required: false
type: string
- name: data_synced
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: location_id
in: query
description: ''
required: false
type: string
- name: location
in: query
description: ''
required: false
type: string
- name: device_type_id
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: platform_id
in: query
description: ''
required: false
type: string
- name: platform
in: query
description: ''
required: false
type: string
- name: cluster_type_id
in: query
description: ''
required: false
type: string
- name: cluster_type
in: query
description: ''
required: false
type: string
- name: cluster_group_id
in: query
description: ''
required: false
type: string
- name: cluster_group
in: query
description: ''
required: false
type: string
- name: cluster_id
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: tag_id
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: data_source_id
in: query
description: ''
required: false
type: string
- name: data_file_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: data_synced__n
in: query
description: ''
required: false
type: string
- name: data_synced__lte
in: query
description: ''
required: false
type: string
- name: data_synced__lt
in: query
description: ''
required: false
type: string
- name: data_synced__gte
in: query
description: ''
required: false
type: string
- name: data_synced__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: location_id__n
in: query
description: ''
required: false
type: string
- name: location__n
in: query
description: ''
required: false
type: string
- name: device_type_id__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: platform_id__n
in: query
description: ''
required: false
type: string
- name: platform__n
in: query
description: ''
required: false
type: string
- name: cluster_type_id__n
in: query
description: ''
required: false
type: string
- name: cluster_type__n
in: query
description: ''
required: false
type: string
- name: cluster_group_id__n
in: query
description: ''
required: false
type: string
- name: cluster_group__n
in: query
description: ''
required: false
type: string
- name: cluster_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: tag_id__n
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: data_source_id__n
in: query
description: ''
required: false
type: string
- name: data_file_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConfigContext'
tags:
- extras
post:
operationId: extras_config-contexts_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigContext'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
put:
operationId: extras_config-contexts_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
patch:
operationId: extras_config-contexts_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
delete:
operationId: extras_config-contexts_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/config-contexts/{id}/:
get:
operationId: extras_config-contexts_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
put:
operationId: extras_config-contexts_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
patch:
operationId: extras_config-contexts_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigContext'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
delete:
operationId: extras_config-contexts_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this config context.
required: true
type: integer
/extras/config-contexts/{id}/sync/:
post:
operationId: extras_config-contexts_sync
description: Provide a /sync API endpoint to synchronize an object's data from
its associated DataFile (if any).
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigContext'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConfigContext'
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this config context.
required: true
type: integer
/extras/config-templates/:
get:
operationId: extras_config-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: data_synced
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: data_source_id
in: query
description: ''
required: false
type: string
- name: data_file_id
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: data_synced__n
in: query
description: ''
required: false
type: string
- name: data_synced__lte
in: query
description: ''
required: false
type: string
- name: data_synced__lt
in: query
description: ''
required: false
type: string
- name: data_synced__gte
in: query
description: ''
required: false
type: string
- name: data_synced__gt
in: query
description: ''
required: false
type: string
- name: data_source_id__n
in: query
description: ''
required: false
type: string
- name: data_file_id__n
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
post:
operationId: extras_config-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
put:
operationId: extras_config-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
patch:
operationId: extras_config-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
delete:
operationId: extras_config-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/config-templates/{id}/:
get:
operationId: extras_config-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
put:
operationId: extras_config-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
patch:
operationId: extras_config-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
delete:
operationId: extras_config-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this config template.
required: true
type: integer
/extras/config-templates/{id}/render/:
post:
operationId: extras_config-templates_render
description: |-
Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data,
return the raw rendered content, rather than serialized JSON.
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
produces:
- application/json
- text/plain
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this config template.
required: true
type: integer
/extras/config-templates/{id}/sync/:
post:
operationId: extras_config-templates_sync
description: Provide a /sync API endpoint to synchronize an object's data from
its associated DataFile (if any).
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableConfigTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConfigTemplate'
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this config template.
required: true
type: integer
/extras/content-types/:
get:
operationId: extras_content-types_list
description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent
to NetBox objects.
parameters:
- name: id
in: query
description: ''
required: false
type: number
- name: app_label
in: query
description: ''
required: false
type: string
- name: model
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ContentType'
tags:
- extras
parameters: []
/extras/content-types/{id}/:
get:
operationId: extras_content-types_read
description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent
to NetBox objects.
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContentType'
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this content type.
required: true
type: integer
/extras/custom-fields/:
get:
operationId: extras_custom-fields_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: content_types
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: group_name
in: query
description: ''
required: false
type: string
- name: required
in: query
description: ''
required: false
type: string
- name: search_weight
in: query
description: ''
required: false
type: string
- name: filter_logic
in: query
description: ''
required: false
type: string
- name: ui_visibility
in: query
description: ''
required: false
type: string
- name: weight
in: query
description: ''
required: false
type: string
- name: is_cloneable
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: content_types__n
in: query
description: ''
required: false
type: string
- name: content_types__ic
in: query
description: ''
required: false
type: string
- name: content_types__nic
in: query
description: ''
required: false
type: string
- name: content_types__iew
in: query
description: ''
required: false
type: string
- name: content_types__niew
in: query
description: ''
required: false
type: string
- name: content_types__isw
in: query
description: ''
required: false
type: string
- name: content_types__nisw
in: query
description: ''
required: false
type: string
- name: content_types__ie
in: query
description: ''
required: false
type: string
- name: content_types__nie
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: group_name__n
in: query
description: ''
required: false
type: string
- name: group_name__ic
in: query
description: ''
required: false
type: string
- name: group_name__nic
in: query
description: ''
required: false
type: string
- name: group_name__iew
in: query
description: ''
required: false
type: string
- name: group_name__niew
in: query
description: ''
required: false
type: string
- name: group_name__isw
in: query
description: ''
required: false
type: string
- name: group_name__nisw
in: query
description: ''
required: false
type: string
- name: group_name__ie
in: query
description: ''
required: false
type: string
- name: group_name__nie
in: query
description: ''
required: false
type: string
- name: group_name__empty
in: query
description: ''
required: false
type: string
- name: search_weight__n
in: query
description: ''
required: false
type: string
- name: search_weight__lte
in: query
description: ''
required: false
type: string
- name: search_weight__lt
in: query
description: ''
required: false
type: string
- name: search_weight__gte
in: query
description: ''
required: false
type: string
- name: search_weight__gt
in: query
description: ''
required: false
type: string
- name: filter_logic__n
in: query
description: ''
required: false
type: string
- name: ui_visibility__n
in: query
description: ''
required: false
type: string
- name: weight__n
in: query
description: ''
required: false
type: string
- name: weight__lte
in: query
description: ''
required: false
type: string
- name: weight__lt
in: query
description: ''
required: false
type: string
- name: weight__gte
in: query
description: ''
required: false
type: string
- name: weight__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: content_type_id__lte
in: query
description: ''
required: false
type: string
- name: content_type_id__lt
in: query
description: ''
required: false
type: string
- name: content_type_id__gte
in: query
description: ''
required: false
type: string
- name: content_type_id__gt
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CustomField'
tags:
- extras
post:
operationId: extras_custom-fields_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCustomField'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CustomField'
tags:
- extras
put:
operationId: extras_custom-fields_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCustomField'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomField'
tags:
- extras
patch:
operationId: extras_custom-fields_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCustomField'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomField'
tags:
- extras
delete:
operationId: extras_custom-fields_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/custom-fields/{id}/:
get:
operationId: extras_custom-fields_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomField'
tags:
- extras
put:
operationId: extras_custom-fields_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCustomField'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomField'
tags:
- extras
patch:
operationId: extras_custom-fields_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCustomField'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomField'
tags:
- extras
delete:
operationId: extras_custom-fields_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this custom field.
required: true
type: integer
/extras/custom-links/:
get:
operationId: extras_custom-links_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: content_types
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: link_text
in: query
description: ''
required: false
type: string
- name: link_url
in: query
description: ''
required: false
type: string
- name: weight
in: query
description: ''
required: false
type: string
- name: group_name
in: query
description: ''
required: false
type: string
- name: new_window
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: content_types__n
in: query
description: ''
required: false
type: string
- name: content_types__ic
in: query
description: ''
required: false
type: string
- name: content_types__nic
in: query
description: ''
required: false
type: string
- name: content_types__iew
in: query
description: ''
required: false
type: string
- name: content_types__niew
in: query
description: ''
required: false
type: string
- name: content_types__isw
in: query
description: ''
required: false
type: string
- name: content_types__nisw
in: query
description: ''
required: false
type: string
- name: content_types__ie
in: query
description: ''
required: false
type: string
- name: content_types__nie
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: link_text__n
in: query
description: ''
required: false
type: string
- name: link_text__ic
in: query
description: ''
required: false
type: string
- name: link_text__nic
in: query
description: ''
required: false
type: string
- name: link_text__iew
in: query
description: ''
required: false
type: string
- name: link_text__niew
in: query
description: ''
required: false
type: string
- name: link_text__isw
in: query
description: ''
required: false
type: string
- name: link_text__nisw
in: query
description: ''
required: false
type: string
- name: link_text__ie
in: query
description: ''
required: false
type: string
- name: link_text__nie
in: query
description: ''
required: false
type: string
- name: link_url__n
in: query
description: ''
required: false
type: string
- name: link_url__ic
in: query
description: ''
required: false
type: string
- name: link_url__nic
in: query
description: ''
required: false
type: string
- name: link_url__iew
in: query
description: ''
required: false
type: string
- name: link_url__niew
in: query
description: ''
required: false
type: string
- name: link_url__isw
in: query
description: ''
required: false
type: string
- name: link_url__nisw
in: query
description: ''
required: false
type: string
- name: link_url__ie
in: query
description: ''
required: false
type: string
- name: link_url__nie
in: query
description: ''
required: false
type: string
- name: weight__n
in: query
description: ''
required: false
type: string
- name: weight__lte
in: query
description: ''
required: false
type: string
- name: weight__lt
in: query
description: ''
required: false
type: string
- name: weight__gte
in: query
description: ''
required: false
type: string
- name: weight__gt
in: query
description: ''
required: false
type: string
- name: group_name__n
in: query
description: ''
required: false
type: string
- name: group_name__ic
in: query
description: ''
required: false
type: string
- name: group_name__nic
in: query
description: ''
required: false
type: string
- name: group_name__iew
in: query
description: ''
required: false
type: string
- name: group_name__niew
in: query
description: ''
required: false
type: string
- name: group_name__isw
in: query
description: ''
required: false
type: string
- name: group_name__nisw
in: query
description: ''
required: false
type: string
- name: group_name__ie
in: query
description: ''
required: false
type: string
- name: group_name__nie
in: query
description: ''
required: false
type: string
- name: group_name__empty
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: content_type_id__lte
in: query
description: ''
required: false
type: string
- name: content_type_id__lt
in: query
description: ''
required: false
type: string
- name: content_type_id__gte
in: query
description: ''
required: false
type: string
- name: content_type_id__gt
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CustomLink'
tags:
- extras
post:
operationId: extras_custom-links_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CustomLink'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CustomLink'
tags:
- extras
put:
operationId: extras_custom-links_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CustomLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomLink'
tags:
- extras
patch:
operationId: extras_custom-links_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CustomLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomLink'
tags:
- extras
delete:
operationId: extras_custom-links_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/custom-links/{id}/:
get:
operationId: extras_custom-links_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomLink'
tags:
- extras
put:
operationId: extras_custom-links_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CustomLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomLink'
tags:
- extras
patch:
operationId: extras_custom-links_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CustomLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CustomLink'
tags:
- extras
delete:
operationId: extras_custom-links_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this custom link.
required: true
type: integer
/extras/dashboard/:
get:
operationId: extras_dashboard_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Dashboard'
tags:
- extras
put:
operationId: extras_dashboard_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Dashboard'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Dashboard'
tags:
- extras
patch:
operationId: extras_dashboard_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Dashboard'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Dashboard'
tags:
- extras
delete:
operationId: extras_dashboard_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/export-templates/:
get:
operationId: extras_export-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: content_types
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: data_synced
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: data_source_id
in: query
description: ''
required: false
type: string
- name: data_file_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: content_types__n
in: query
description: ''
required: false
type: string
- name: content_types__ic
in: query
description: ''
required: false
type: string
- name: content_types__nic
in: query
description: ''
required: false
type: string
- name: content_types__iew
in: query
description: ''
required: false
type: string
- name: content_types__niew
in: query
description: ''
required: false
type: string
- name: content_types__isw
in: query
description: ''
required: false
type: string
- name: content_types__nisw
in: query
description: ''
required: false
type: string
- name: content_types__ie
in: query
description: ''
required: false
type: string
- name: content_types__nie
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: data_synced__n
in: query
description: ''
required: false
type: string
- name: data_synced__lte
in: query
description: ''
required: false
type: string
- name: data_synced__lt
in: query
description: ''
required: false
type: string
- name: data_synced__gte
in: query
description: ''
required: false
type: string
- name: data_synced__gt
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: content_type_id__lte
in: query
description: ''
required: false
type: string
- name: content_type_id__lt
in: query
description: ''
required: false
type: string
- name: content_type_id__gte
in: query
description: ''
required: false
type: string
- name: content_type_id__gt
in: query
description: ''
required: false
type: string
- name: data_source_id__n
in: query
description: ''
required: false
type: string
- name: data_file_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
post:
operationId: extras_export-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableExportTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
put:
operationId: extras_export-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableExportTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
patch:
operationId: extras_export-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableExportTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
delete:
operationId: extras_export-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/export-templates/{id}/:
get:
operationId: extras_export-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
put:
operationId: extras_export-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableExportTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
patch:
operationId: extras_export-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableExportTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
delete:
operationId: extras_export-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this export template.
required: true
type: integer
/extras/export-templates/{id}/sync/:
post:
operationId: extras_export-templates_sync
description: Provide a /sync API endpoint to synchronize an object's data from
its associated DataFile (if any).
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableExportTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ExportTemplate'
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this export template.
required: true
type: integer
/extras/image-attachments/:
get:
operationId: extras_image-attachments_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: object_id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: content_type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: object_id__n
in: query
description: ''
required: false
type: string
- name: object_id__lte
in: query
description: ''
required: false
type: string
- name: object_id__lt
in: query
description: ''
required: false
type: string
- name: object_id__gte
in: query
description: ''
required: false
type: string
- name: object_id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: content_type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
post:
operationId: extras_image-attachments_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ImageAttachment'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
put:
operationId: extras_image-attachments_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ImageAttachment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
patch:
operationId: extras_image-attachments_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ImageAttachment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
delete:
operationId: extras_image-attachments_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/image-attachments/{id}/:
get:
operationId: extras_image-attachments_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
put:
operationId: extras_image-attachments_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ImageAttachment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
patch:
operationId: extras_image-attachments_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ImageAttachment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ImageAttachment'
tags:
- extras
delete:
operationId: extras_image-attachments_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this image attachment.
required: true
type: integer
/extras/journal-entries/:
get:
operationId: extras_journal-entries_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: assigned_object_type_id
in: query
description: ''
required: false
type: string
- name: assigned_object_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: kind
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: assigned_object_type
in: query
description: ''
required: false
type: string
- name: created_by_id
in: query
description: ''
required: false
type: string
- name: created_by
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: assigned_object_type_id__n
in: query
description: ''
required: false
type: string
- name: assigned_object_id__n
in: query
description: ''
required: false
type: string
- name: assigned_object_id__lte
in: query
description: ''
required: false
type: string
- name: assigned_object_id__lt
in: query
description: ''
required: false
type: string
- name: assigned_object_id__gte
in: query
description: ''
required: false
type: string
- name: assigned_object_id__gt
in: query
description: ''
required: false
type: string
- name: kind__n
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: assigned_object_type__n
in: query
description: ''
required: false
type: string
- name: created_by_id__n
in: query
description: ''
required: false
type: string
- name: created_by__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/JournalEntry'
tags:
- extras
post:
operationId: extras_journal-entries_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableJournalEntry'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/JournalEntry'
tags:
- extras
put:
operationId: extras_journal-entries_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableJournalEntry'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/JournalEntry'
tags:
- extras
patch:
operationId: extras_journal-entries_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableJournalEntry'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/JournalEntry'
tags:
- extras
delete:
operationId: extras_journal-entries_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/journal-entries/{id}/:
get:
operationId: extras_journal-entries_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/JournalEntry'
tags:
- extras
put:
operationId: extras_journal-entries_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableJournalEntry'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/JournalEntry'
tags:
- extras
patch:
operationId: extras_journal-entries_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableJournalEntry'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/JournalEntry'
tags:
- extras
delete:
operationId: extras_journal-entries_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this journal entry.
required: true
type: integer
/extras/object-changes/:
get:
operationId: extras_object-changes_list
description: Retrieve a list of recent changes.
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: user
in: query
description: ''
required: false
type: string
- name: user_name
in: query
description: ''
required: false
type: string
- name: request_id
in: query
description: ''
required: false
type: string
- name: action
in: query
description: ''
required: false
type: string
- name: changed_object_type_id
in: query
description: ''
required: false
type: string
- name: changed_object_id
in: query
description: ''
required: false
type: string
- name: object_repr
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: time
in: query
description: ''
required: false
type: string
- name: changed_object_type
in: query
description: ''
required: false
type: string
- name: user_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: user__n
in: query
description: ''
required: false
type: string
- name: user_name__n
in: query
description: ''
required: false
type: string
- name: user_name__ic
in: query
description: ''
required: false
type: string
- name: user_name__nic
in: query
description: ''
required: false
type: string
- name: user_name__iew
in: query
description: ''
required: false
type: string
- name: user_name__niew
in: query
description: ''
required: false
type: string
- name: user_name__isw
in: query
description: ''
required: false
type: string
- name: user_name__nisw
in: query
description: ''
required: false
type: string
- name: user_name__ie
in: query
description: ''
required: false
type: string
- name: user_name__nie
in: query
description: ''
required: false
type: string
- name: user_name__empty
in: query
description: ''
required: false
type: string
- name: action__n
in: query
description: ''
required: false
type: string
- name: changed_object_type_id__n
in: query
description: ''
required: false
type: string
- name: changed_object_id__n
in: query
description: ''
required: false
type: string
- name: changed_object_id__lte
in: query
description: ''
required: false
type: string
- name: changed_object_id__lt
in: query
description: ''
required: false
type: string
- name: changed_object_id__gte
in: query
description: ''
required: false
type: string
- name: changed_object_id__gt
in: query
description: ''
required: false
type: string
- name: object_repr__n
in: query
description: ''
required: false
type: string
- name: object_repr__ic
in: query
description: ''
required: false
type: string
- name: object_repr__nic
in: query
description: ''
required: false
type: string
- name: object_repr__iew
in: query
description: ''
required: false
type: string
- name: object_repr__niew
in: query
description: ''
required: false
type: string
- name: object_repr__isw
in: query
description: ''
required: false
type: string
- name: object_repr__nisw
in: query
description: ''
required: false
type: string
- name: object_repr__ie
in: query
description: ''
required: false
type: string
- name: object_repr__nie
in: query
description: ''
required: false
type: string
- name: object_repr__empty
in: query
description: ''
required: false
type: string
- name: changed_object_type__n
in: query
description: ''
required: false
type: string
- name: user_id__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ObjectChange'
tags:
- extras
parameters: []
/extras/object-changes/{id}/:
get:
operationId: extras_object-changes_read
description: Retrieve a list of recent changes.
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ObjectChange'
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this object change.
required: true
type: integer
/extras/reports/:
get:
operationId: extras_reports_list
description: Compile all reports and their related results (if any). Result
data is deferred in the list view.
parameters: []
responses:
'200':
description: ''
tags:
- extras
parameters: []
/extras/reports/{id}/:
get:
operationId: extras_reports_read
description: Retrieve a single Report identified as "<module>.<report>".
parameters: []
responses:
'200':
description: ''
tags:
- extras
parameters:
- name: id
in: path
required: true
type: string
/extras/reports/{id}/run/:
post:
operationId: extras_reports_run
description: Run a Report identified as "<module>.<script>" and return the pending
Job as the result
parameters: []
responses:
'201':
description: ''
tags:
- extras
parameters:
- name: id
in: path
required: true
type: string
/extras/saved-filters/:
get:
operationId: extras_saved-filters_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: content_types
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: shared
in: query
description: ''
required: false
type: string
- name: weight
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: user_id
in: query
description: ''
required: false
type: string
- name: user
in: query
description: ''
required: false
type: string
- name: usable
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: content_types__n
in: query
description: ''
required: false
type: string
- name: content_types__ic
in: query
description: ''
required: false
type: string
- name: content_types__nic
in: query
description: ''
required: false
type: string
- name: content_types__iew
in: query
description: ''
required: false
type: string
- name: content_types__niew
in: query
description: ''
required: false
type: string
- name: content_types__isw
in: query
description: ''
required: false
type: string
- name: content_types__nisw
in: query
description: ''
required: false
type: string
- name: content_types__ie
in: query
description: ''
required: false
type: string
- name: content_types__nie
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: weight__n
in: query
description: ''
required: false
type: string
- name: weight__lte
in: query
description: ''
required: false
type: string
- name: weight__lt
in: query
description: ''
required: false
type: string
- name: weight__gte
in: query
description: ''
required: false
type: string
- name: weight__gt
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: content_type_id__lte
in: query
description: ''
required: false
type: string
- name: content_type_id__lt
in: query
description: ''
required: false
type: string
- name: content_type_id__gte
in: query
description: ''
required: false
type: string
- name: content_type_id__gt
in: query
description: ''
required: false
type: string
- name: user_id__n
in: query
description: ''
required: false
type: string
- name: user__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/SavedFilter'
tags:
- extras
post:
operationId: extras_saved-filters_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SavedFilter'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/SavedFilter'
tags:
- extras
put:
operationId: extras_saved-filters_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SavedFilter'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SavedFilter'
tags:
- extras
patch:
operationId: extras_saved-filters_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SavedFilter'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SavedFilter'
tags:
- extras
delete:
operationId: extras_saved-filters_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/saved-filters/{id}/:
get:
operationId: extras_saved-filters_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SavedFilter'
tags:
- extras
put:
operationId: extras_saved-filters_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SavedFilter'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SavedFilter'
tags:
- extras
patch:
operationId: extras_saved-filters_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SavedFilter'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SavedFilter'
tags:
- extras
delete:
operationId: extras_saved-filters_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this saved filter.
required: true
type: integer
/extras/scripts/:
get:
operationId: extras_scripts_list
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- extras
parameters: []
/extras/scripts/{id}/:
get:
operationId: extras_scripts_read
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- extras
parameters:
- name: id
in: path
required: true
type: string
/extras/tags/:
get:
operationId: extras_tags_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: color
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: content_type
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: color__n
in: query
description: ''
required: false
type: string
- name: color__ic
in: query
description: ''
required: false
type: string
- name: color__nic
in: query
description: ''
required: false
type: string
- name: color__iew
in: query
description: ''
required: false
type: string
- name: color__niew
in: query
description: ''
required: false
type: string
- name: color__isw
in: query
description: ''
required: false
type: string
- name: color__nisw
in: query
description: ''
required: false
type: string
- name: color__ie
in: query
description: ''
required: false
type: string
- name: color__nie
in: query
description: ''
required: false
type: string
- name: color__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Tag'
tags:
- extras
post:
operationId: extras_tags_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Tag'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Tag'
tags:
- extras
put:
operationId: extras_tags_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Tag'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tag'
tags:
- extras
patch:
operationId: extras_tags_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Tag'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tag'
tags:
- extras
delete:
operationId: extras_tags_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/tags/{id}/:
get:
operationId: extras_tags_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tag'
tags:
- extras
put:
operationId: extras_tags_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Tag'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tag'
tags:
- extras
patch:
operationId: extras_tags_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Tag'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tag'
tags:
- extras
delete:
operationId: extras_tags_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this tag.
required: true
type: integer
/extras/webhooks/:
get:
operationId: extras_webhooks_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: type_create
in: query
description: ''
required: false
type: string
- name: type_update
in: query
description: ''
required: false
type: string
- name: type_delete
in: query
description: ''
required: false
type: string
- name: type_job_start
in: query
description: ''
required: false
type: string
- name: type_job_end
in: query
description: ''
required: false
type: string
- name: payload_url
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: http_method
in: query
description: ''
required: false
type: string
- name: http_content_type
in: query
description: ''
required: false
type: string
- name: secret
in: query
description: ''
required: false
type: string
- name: ssl_verification
in: query
description: ''
required: false
type: string
- name: ca_file_path
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: content_types
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: payload_url__n
in: query
description: ''
required: false
type: string
- name: payload_url__ic
in: query
description: ''
required: false
type: string
- name: payload_url__nic
in: query
description: ''
required: false
type: string
- name: payload_url__iew
in: query
description: ''
required: false
type: string
- name: payload_url__niew
in: query
description: ''
required: false
type: string
- name: payload_url__isw
in: query
description: ''
required: false
type: string
- name: payload_url__nisw
in: query
description: ''
required: false
type: string
- name: payload_url__ie
in: query
description: ''
required: false
type: string
- name: payload_url__nie
in: query
description: ''
required: false
type: string
- name: payload_url__empty
in: query
description: ''
required: false
type: string
- name: http_method__n
in: query
description: ''
required: false
type: string
- name: http_content_type__n
in: query
description: ''
required: false
type: string
- name: http_content_type__ic
in: query
description: ''
required: false
type: string
- name: http_content_type__nic
in: query
description: ''
required: false
type: string
- name: http_content_type__iew
in: query
description: ''
required: false
type: string
- name: http_content_type__niew
in: query
description: ''
required: false
type: string
- name: http_content_type__isw
in: query
description: ''
required: false
type: string
- name: http_content_type__nisw
in: query
description: ''
required: false
type: string
- name: http_content_type__ie
in: query
description: ''
required: false
type: string
- name: http_content_type__nie
in: query
description: ''
required: false
type: string
- name: http_content_type__empty
in: query
description: ''
required: false
type: string
- name: secret__n
in: query
description: ''
required: false
type: string
- name: secret__ic
in: query
description: ''
required: false
type: string
- name: secret__nic
in: query
description: ''
required: false
type: string
- name: secret__iew
in: query
description: ''
required: false
type: string
- name: secret__niew
in: query
description: ''
required: false
type: string
- name: secret__isw
in: query
description: ''
required: false
type: string
- name: secret__nisw
in: query
description: ''
required: false
type: string
- name: secret__ie
in: query
description: ''
required: false
type: string
- name: secret__nie
in: query
description: ''
required: false
type: string
- name: secret__empty
in: query
description: ''
required: false
type: string
- name: ca_file_path__n
in: query
description: ''
required: false
type: string
- name: ca_file_path__ic
in: query
description: ''
required: false
type: string
- name: ca_file_path__nic
in: query
description: ''
required: false
type: string
- name: ca_file_path__iew
in: query
description: ''
required: false
type: string
- name: ca_file_path__niew
in: query
description: ''
required: false
type: string
- name: ca_file_path__isw
in: query
description: ''
required: false
type: string
- name: ca_file_path__nisw
in: query
description: ''
required: false
type: string
- name: ca_file_path__ie
in: query
description: ''
required: false
type: string
- name: ca_file_path__nie
in: query
description: ''
required: false
type: string
- name: ca_file_path__empty
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: content_type_id__lte
in: query
description: ''
required: false
type: string
- name: content_type_id__lt
in: query
description: ''
required: false
type: string
- name: content_type_id__gte
in: query
description: ''
required: false
type: string
- name: content_type_id__gt
in: query
description: ''
required: false
type: string
- name: content_types__n
in: query
description: ''
required: false
type: string
- name: content_types__ic
in: query
description: ''
required: false
type: string
- name: content_types__nic
in: query
description: ''
required: false
type: string
- name: content_types__iew
in: query
description: ''
required: false
type: string
- name: content_types__niew
in: query
description: ''
required: false
type: string
- name: content_types__isw
in: query
description: ''
required: false
type: string
- name: content_types__nisw
in: query
description: ''
required: false
type: string
- name: content_types__ie
in: query
description: ''
required: false
type: string
- name: content_types__nie
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Webhook'
tags:
- extras
post:
operationId: extras_webhooks_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Webhook'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Webhook'
tags:
- extras
put:
operationId: extras_webhooks_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Webhook'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Webhook'
tags:
- extras
patch:
operationId: extras_webhooks_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Webhook'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Webhook'
tags:
- extras
delete:
operationId: extras_webhooks_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters: []
/extras/webhooks/{id}/:
get:
operationId: extras_webhooks_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Webhook'
tags:
- extras
put:
operationId: extras_webhooks_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Webhook'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Webhook'
tags:
- extras
patch:
operationId: extras_webhooks_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Webhook'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Webhook'
tags:
- extras
delete:
operationId: extras_webhooks_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- extras
parameters:
- name: id
in: path
description: A unique integer value identifying this webhook.
required: true
type: integer
/ipam/aggregates/:
get:
operationId: ipam_aggregates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: date_added
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: family
in: query
description: ''
required: false
type: number
- name: prefix
in: query
description: ''
required: false
type: string
- name: rir_id
in: query
description: ''
required: false
type: string
- name: rir
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: date_added__n
in: query
description: ''
required: false
type: string
- name: date_added__lte
in: query
description: ''
required: false
type: string
- name: date_added__lt
in: query
description: ''
required: false
type: string
- name: date_added__gte
in: query
description: ''
required: false
type: string
- name: date_added__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: rir_id__n
in: query
description: ''
required: false
type: string
- name: rir__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Aggregate'
tags:
- ipam
post:
operationId: ipam_aggregates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAggregate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Aggregate'
tags:
- ipam
put:
operationId: ipam_aggregates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAggregate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Aggregate'
tags:
- ipam
patch:
operationId: ipam_aggregates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAggregate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Aggregate'
tags:
- ipam
delete:
operationId: ipam_aggregates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/aggregates/{id}/:
get:
operationId: ipam_aggregates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Aggregate'
tags:
- ipam
put:
operationId: ipam_aggregates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAggregate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Aggregate'
tags:
- ipam
patch:
operationId: ipam_aggregates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAggregate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Aggregate'
tags:
- ipam
delete:
operationId: ipam_aggregates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this aggregate.
required: true
type: integer
/ipam/asn-ranges/:
get:
operationId: ipam_asn-ranges_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: start
in: query
description: ''
required: false
type: string
- name: end
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: rir_id
in: query
description: ''
required: false
type: string
- name: rir
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: start__n
in: query
description: ''
required: false
type: string
- name: start__lte
in: query
description: ''
required: false
type: string
- name: start__lt
in: query
description: ''
required: false
type: string
- name: start__gte
in: query
description: ''
required: false
type: string
- name: start__gt
in: query
description: ''
required: false
type: string
- name: end__n
in: query
description: ''
required: false
type: string
- name: end__lte
in: query
description: ''
required: false
type: string
- name: end__lt
in: query
description: ''
required: false
type: string
- name: end__gte
in: query
description: ''
required: false
type: string
- name: end__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: rir_id__n
in: query
description: ''
required: false
type: string
- name: rir__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ASNRange'
tags:
- ipam
post:
operationId: ipam_asn-ranges_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASNRange'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ASNRange'
tags:
- ipam
put:
operationId: ipam_asn-ranges_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASNRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASNRange'
tags:
- ipam
patch:
operationId: ipam_asn-ranges_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASNRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASNRange'
tags:
- ipam
delete:
operationId: ipam_asn-ranges_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/asn-ranges/{id}/:
get:
operationId: ipam_asn-ranges_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASNRange'
tags:
- ipam
put:
operationId: ipam_asn-ranges_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASNRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASNRange'
tags:
- ipam
patch:
operationId: ipam_asn-ranges_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASNRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASNRange'
tags:
- ipam
delete:
operationId: ipam_asn-ranges_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this ASN range.
required: true
type: integer
/ipam/asn-ranges/{id}/available-asns/:
get:
operationId: ipam_asn-ranges_available-asns_list
description: ''
parameters: []
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/AvailableASN'
tags:
- ipam
post:
operationId: ipam_asn-ranges_available-asns_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/AvailableASN'
responses:
'201':
description: ''
schema:
type: array
items:
$ref: '#/definitions/ASN'
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this ASN.
required: true
type: integer
/ipam/asns/:
get:
operationId: ipam_asns_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: asn
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: rir_id
in: query
description: ''
required: false
type: string
- name: rir
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: asn__n
in: query
description: ''
required: false
type: string
- name: asn__lte
in: query
description: ''
required: false
type: string
- name: asn__lt
in: query
description: ''
required: false
type: string
- name: asn__gte
in: query
description: ''
required: false
type: string
- name: asn__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: rir_id__n
in: query
description: ''
required: false
type: string
- name: rir__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ASN'
tags:
- ipam
post:
operationId: ipam_asns_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASN'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ASN'
tags:
- ipam
put:
operationId: ipam_asns_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASN'
tags:
- ipam
patch:
operationId: ipam_asns_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASN'
tags:
- ipam
delete:
operationId: ipam_asns_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/asns/{id}/:
get:
operationId: ipam_asns_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASN'
tags:
- ipam
put:
operationId: ipam_asns_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASN'
tags:
- ipam
patch:
operationId: ipam_asns_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableASN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ASN'
tags:
- ipam
delete:
operationId: ipam_asns_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this ASN.
required: true
type: integer
/ipam/fhrp-group-assignments/:
get:
operationId: ipam_fhrp-group-assignments_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: interface_type
in: query
description: ''
required: false
type: string
- name: interface_id
in: query
description: ''
required: false
type: string
- name: priority
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: virtual_machine
in: query
description: ''
required: false
type: string
- name: virtual_machine_id
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: interface_type__n
in: query
description: ''
required: false
type: string
- name: interface_id__n
in: query
description: ''
required: false
type: string
- name: interface_id__lte
in: query
description: ''
required: false
type: string
- name: interface_id__lt
in: query
description: ''
required: false
type: string
- name: interface_id__gte
in: query
description: ''
required: false
type: string
- name: interface_id__gt
in: query
description: ''
required: false
type: string
- name: priority__n
in: query
description: ''
required: false
type: string
- name: priority__lte
in: query
description: ''
required: false
type: string
- name: priority__lt
in: query
description: ''
required: false
type: string
- name: priority__gte
in: query
description: ''
required: false
type: string
- name: priority__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
post:
operationId: ipam_fhrp-group-assignments_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFHRPGroupAssignment'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
put:
operationId: ipam_fhrp-group-assignments_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFHRPGroupAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
patch:
operationId: ipam_fhrp-group-assignments_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFHRPGroupAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
delete:
operationId: ipam_fhrp-group-assignments_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/fhrp-group-assignments/{id}/:
get:
operationId: ipam_fhrp-group-assignments_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
put:
operationId: ipam_fhrp-group-assignments_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFHRPGroupAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
patch:
operationId: ipam_fhrp-group-assignments_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableFHRPGroupAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroupAssignment'
tags:
- ipam
delete:
operationId: ipam_fhrp-group-assignments_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this FHRP group assignment.
required: true
type: integer
/ipam/fhrp-groups/:
get:
operationId: ipam_fhrp-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: auth_key
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: protocol
in: query
description: ''
required: false
type: string
- name: auth_type
in: query
description: ''
required: false
type: string
- name: related_ip
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group_id__lte
in: query
description: ''
required: false
type: string
- name: group_id__lt
in: query
description: ''
required: false
type: string
- name: group_id__gte
in: query
description: ''
required: false
type: string
- name: group_id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: auth_key__n
in: query
description: ''
required: false
type: string
- name: auth_key__ic
in: query
description: ''
required: false
type: string
- name: auth_key__nic
in: query
description: ''
required: false
type: string
- name: auth_key__iew
in: query
description: ''
required: false
type: string
- name: auth_key__niew
in: query
description: ''
required: false
type: string
- name: auth_key__isw
in: query
description: ''
required: false
type: string
- name: auth_key__nisw
in: query
description: ''
required: false
type: string
- name: auth_key__ie
in: query
description: ''
required: false
type: string
- name: auth_key__nie
in: query
description: ''
required: false
type: string
- name: auth_key__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: protocol__n
in: query
description: ''
required: false
type: string
- name: auth_type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
post:
operationId: ipam_fhrp-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FHRPGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
put:
operationId: ipam_fhrp-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FHRPGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
patch:
operationId: ipam_fhrp-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FHRPGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
delete:
operationId: ipam_fhrp-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/fhrp-groups/{id}/:
get:
operationId: ipam_fhrp-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
put:
operationId: ipam_fhrp-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FHRPGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
patch:
operationId: ipam_fhrp-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FHRPGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FHRPGroup'
tags:
- ipam
delete:
operationId: ipam_fhrp-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this FHRP group.
required: true
type: integer
/ipam/ip-addresses/:
get:
operationId: ipam_ip-addresses_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: dns_name
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: family
in: query
description: ''
required: false
type: number
- name: parent
in: query
description: ''
required: false
type: string
- name: address
in: query
description: ''
required: false
type: string
- name: mask_length
in: query
description: ''
required: false
type: number
- name: vrf_id
in: query
description: ''
required: false
type: string
- name: vrf
in: query
description: ''
required: false
type: string
- name: present_in_vrf_id
in: query
description: ''
required: false
type: string
- name: present_in_vrf
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: virtual_machine
in: query
description: ''
required: false
type: string
- name: virtual_machine_id
in: query
description: ''
required: false
type: string
- name: interface
in: query
description: ''
required: false
type: string
- name: interface_id
in: query
description: ''
required: false
type: string
- name: vminterface
in: query
description: ''
required: false
type: string
- name: vminterface_id
in: query
description: ''
required: false
type: string
- name: fhrpgroup_id
in: query
description: ''
required: false
type: string
- name: assigned_to_interface
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: dns_name__n
in: query
description: ''
required: false
type: string
- name: dns_name__ic
in: query
description: ''
required: false
type: string
- name: dns_name__nic
in: query
description: ''
required: false
type: string
- name: dns_name__iew
in: query
description: ''
required: false
type: string
- name: dns_name__niew
in: query
description: ''
required: false
type: string
- name: dns_name__isw
in: query
description: ''
required: false
type: string
- name: dns_name__nisw
in: query
description: ''
required: false
type: string
- name: dns_name__ie
in: query
description: ''
required: false
type: string
- name: dns_name__nie
in: query
description: ''
required: false
type: string
- name: dns_name__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: vrf_id__n
in: query
description: ''
required: false
type: string
- name: vrf__n
in: query
description: ''
required: false
type: string
- name: interface__n
in: query
description: ''
required: false
type: string
- name: interface_id__n
in: query
description: ''
required: false
type: string
- name: vminterface__n
in: query
description: ''
required: false
type: string
- name: vminterface_id__n
in: query
description: ''
required: false
type: string
- name: fhrpgroup_id__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/IPAddress'
tags:
- ipam
post:
operationId: ipam_ip-addresses_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPAddress'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/IPAddress'
tags:
- ipam
put:
operationId: ipam_ip-addresses_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPAddress'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPAddress'
tags:
- ipam
patch:
operationId: ipam_ip-addresses_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPAddress'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPAddress'
tags:
- ipam
delete:
operationId: ipam_ip-addresses_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/ip-addresses/{id}/:
get:
operationId: ipam_ip-addresses_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPAddress'
tags:
- ipam
put:
operationId: ipam_ip-addresses_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPAddress'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPAddress'
tags:
- ipam
patch:
operationId: ipam_ip-addresses_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPAddress'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPAddress'
tags:
- ipam
delete:
operationId: ipam_ip-addresses_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
type: integer
/ipam/ip-ranges/:
get:
operationId: ipam_ip-ranges_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: mark_utilized
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: family
in: query
description: ''
required: false
type: number
- name: start_address
in: query
description: ''
required: false
type: string
- name: end_address
in: query
description: ''
required: false
type: string
- name: contains
in: query
description: ''
required: false
type: string
- name: vrf_id
in: query
description: ''
required: false
type: string
- name: vrf
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: vrf_id__n
in: query
description: ''
required: false
type: string
- name: vrf__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/IPRange'
tags:
- ipam
post:
operationId: ipam_ip-ranges_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPRange'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/IPRange'
tags:
- ipam
put:
operationId: ipam_ip-ranges_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPRange'
tags:
- ipam
patch:
operationId: ipam_ip-ranges_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPRange'
tags:
- ipam
delete:
operationId: ipam_ip-ranges_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/ip-ranges/{id}/:
get:
operationId: ipam_ip-ranges_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPRange'
tags:
- ipam
put:
operationId: ipam_ip-ranges_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPRange'
tags:
- ipam
patch:
operationId: ipam_ip-ranges_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableIPRange'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IPRange'
tags:
- ipam
delete:
operationId: ipam_ip-ranges_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this IP range.
required: true
type: integer
/ipam/ip-ranges/{id}/available-ips/:
get:
operationId: ipam_ip-ranges_available-ips_list
description: ''
parameters: []
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/AvailableIP'
tags:
- ipam
post:
operationId: ipam_ip-ranges_available-ips_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAvailableIP'
responses:
'201':
description: ''
schema:
type: array
items:
$ref: '#/definitions/IPAddress'
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
type: integer
/ipam/l2vpn-terminations/:
get:
operationId: ipam_l2vpn-terminations_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: assigned_object_type_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: l2vpn_id
in: query
description: ''
required: false
type: string
- name: l2vpn
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: virtual_machine
in: query
description: ''
required: false
type: string
- name: virtual_machine_id
in: query
description: ''
required: false
type: string
- name: interface
in: query
description: ''
required: false
type: string
- name: interface_id
in: query
description: ''
required: false
type: string
- name: vminterface
in: query
description: ''
required: false
type: string
- name: vminterface_id
in: query
description: ''
required: false
type: string
- name: vlan
in: query
description: ''
required: false
type: string
- name: vlan_vid
in: query
description: ''
required: false
type: number
- name: vlan_id
in: query
description: ''
required: false
type: string
- name: assigned_object_type
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: assigned_object_type_id__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: l2vpn_id__n
in: query
description: ''
required: false
type: string
- name: l2vpn__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: virtual_machine__n
in: query
description: ''
required: false
type: string
- name: virtual_machine_id__n
in: query
description: ''
required: false
type: string
- name: interface__n
in: query
description: ''
required: false
type: string
- name: interface_id__n
in: query
description: ''
required: false
type: string
- name: vminterface__n
in: query
description: ''
required: false
type: string
- name: vminterface_id__n
in: query
description: ''
required: false
type: string
- name: vlan__n
in: query
description: ''
required: false
type: string
- name: vlan_vid__n
in: query
description: ''
required: false
type: number
- name: vlan_vid__lte
in: query
description: ''
required: false
type: number
- name: vlan_vid__lt
in: query
description: ''
required: false
type: number
- name: vlan_vid__gte
in: query
description: ''
required: false
type: number
- name: vlan_vid__gt
in: query
description: ''
required: false
type: number
- name: vlan_id__n
in: query
description: ''
required: false
type: string
- name: assigned_object_type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
post:
operationId: ipam_l2vpn-terminations_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPNTermination'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
put:
operationId: ipam_l2vpn-terminations_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPNTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
patch:
operationId: ipam_l2vpn-terminations_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPNTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
delete:
operationId: ipam_l2vpn-terminations_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/l2vpn-terminations/{id}/:
get:
operationId: ipam_l2vpn-terminations_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
put:
operationId: ipam_l2vpn-terminations_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPNTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
patch:
operationId: ipam_l2vpn-terminations_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPNTermination'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPNTermination'
tags:
- ipam
delete:
operationId: ipam_l2vpn-terminations_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this L2VPN termination.
required: true
type: integer
/ipam/l2vpns/:
get:
operationId: ipam_l2vpns_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: identifier
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: import_target_id
in: query
description: ''
required: false
type: string
- name: import_target
in: query
description: ''
required: false
type: string
- name: export_target_id
in: query
description: ''
required: false
type: string
- name: export_target
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: identifier__n
in: query
description: ''
required: false
type: string
- name: identifier__lte
in: query
description: ''
required: false
type: string
- name: identifier__lt
in: query
description: ''
required: false
type: string
- name: identifier__gte
in: query
description: ''
required: false
type: string
- name: identifier__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: import_target_id__n
in: query
description: ''
required: false
type: string
- name: import_target__n
in: query
description: ''
required: false
type: string
- name: export_target_id__n
in: query
description: ''
required: false
type: string
- name: export_target__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/L2VPN'
tags:
- ipam
post:
operationId: ipam_l2vpns_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPN'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/L2VPN'
tags:
- ipam
put:
operationId: ipam_l2vpns_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPN'
tags:
- ipam
patch:
operationId: ipam_l2vpns_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPN'
tags:
- ipam
delete:
operationId: ipam_l2vpns_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/l2vpns/{id}/:
get:
operationId: ipam_l2vpns_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPN'
tags:
- ipam
put:
operationId: ipam_l2vpns_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPN'
tags:
- ipam
patch:
operationId: ipam_l2vpns_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableL2VPN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/L2VPN'
tags:
- ipam
delete:
operationId: ipam_l2vpns_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this L2VPN.
required: true
type: integer
/ipam/prefixes/:
get:
operationId: ipam_prefixes_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: is_pool
in: query
description: ''
required: false
type: string
- name: mark_utilized
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: family
in: query
description: ''
required: false
type: number
- name: prefix
in: query
description: ''
required: false
type: string
- name: within
in: query
description: ''
required: false
type: string
- name: within_include
in: query
description: ''
required: false
type: string
- name: contains
in: query
description: ''
required: false
type: string
- name: depth
in: query
description: ''
required: false
type: string
- name: children
in: query
description: ''
required: false
type: string
- name: mask_length
in: query
description: ''
required: false
type: string
- name: mask_length__gte
in: query
description: ''
required: false
type: number
- name: mask_length__lte
in: query
description: ''
required: false
type: number
- name: vrf_id
in: query
description: ''
required: false
type: string
- name: vrf
in: query
description: ''
required: false
type: string
- name: present_in_vrf_id
in: query
description: ''
required: false
type: string
- name: present_in_vrf
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: vlan_id
in: query
description: ''
required: false
type: string
- name: vlan_vid
in: query
description: ''
required: false
type: number
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: depth__n
in: query
description: ''
required: false
type: string
- name: depth__lte
in: query
description: ''
required: false
type: string
- name: depth__lt
in: query
description: ''
required: false
type: string
- name: depth__gte
in: query
description: ''
required: false
type: string
- name: depth__gt
in: query
description: ''
required: false
type: string
- name: children__n
in: query
description: ''
required: false
type: string
- name: children__lte
in: query
description: ''
required: false
type: string
- name: children__lt
in: query
description: ''
required: false
type: string
- name: children__gte
in: query
description: ''
required: false
type: string
- name: children__gt
in: query
description: ''
required: false
type: string
- name: vrf_id__n
in: query
description: ''
required: false
type: string
- name: vrf__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: vlan_id__n
in: query
description: ''
required: false
type: string
- name: vlan_vid__n
in: query
description: ''
required: false
type: number
- name: vlan_vid__lte
in: query
description: ''
required: false
type: number
- name: vlan_vid__lt
in: query
description: ''
required: false
type: number
- name: vlan_vid__gte
in: query
description: ''
required: false
type: number
- name: vlan_vid__gt
in: query
description: ''
required: false
type: number
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Prefix'
tags:
- ipam
post:
operationId: ipam_prefixes_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePrefix'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Prefix'
tags:
- ipam
put:
operationId: ipam_prefixes_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePrefix'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prefix'
tags:
- ipam
patch:
operationId: ipam_prefixes_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePrefix'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prefix'
tags:
- ipam
delete:
operationId: ipam_prefixes_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/prefixes/{id}/:
get:
operationId: ipam_prefixes_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prefix'
tags:
- ipam
put:
operationId: ipam_prefixes_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePrefix'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prefix'
tags:
- ipam
patch:
operationId: ipam_prefixes_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritablePrefix'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prefix'
tags:
- ipam
delete:
operationId: ipam_prefixes_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
type: integer
/ipam/prefixes/{id}/available-ips/:
get:
operationId: ipam_prefixes_available-ips_list
description: ''
parameters: []
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/AvailableIP'
tags:
- ipam
post:
operationId: ipam_prefixes_available-ips_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableAvailableIP'
responses:
'201':
description: ''
schema:
type: array
items:
$ref: '#/definitions/IPAddress'
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this IP address.
required: true
type: integer
/ipam/prefixes/{id}/available-prefixes/:
get:
operationId: ipam_prefixes_available-prefixes_list
description: ''
parameters: []
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/AvailablePrefix'
tags:
- ipam
post:
operationId: ipam_prefixes_available-prefixes_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PrefixLength'
responses:
'201':
description: ''
schema:
type: array
items:
$ref: '#/definitions/Prefix'
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this prefix.
required: true
type: integer
/ipam/rirs/:
get:
operationId: ipam_rirs_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: is_private
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/RIR'
tags:
- ipam
post:
operationId: ipam_rirs_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RIR'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/RIR'
tags:
- ipam
put:
operationId: ipam_rirs_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RIR'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RIR'
tags:
- ipam
patch:
operationId: ipam_rirs_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RIR'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RIR'
tags:
- ipam
delete:
operationId: ipam_rirs_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/rirs/{id}/:
get:
operationId: ipam_rirs_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RIR'
tags:
- ipam
put:
operationId: ipam_rirs_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RIR'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RIR'
tags:
- ipam
patch:
operationId: ipam_rirs_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/RIR'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RIR'
tags:
- ipam
delete:
operationId: ipam_rirs_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this RIR.
required: true
type: integer
/ipam/roles/:
get:
operationId: ipam_roles_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Role'
tags:
- ipam
post:
operationId: ipam_roles_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Role'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Role'
tags:
- ipam
put:
operationId: ipam_roles_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Role'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Role'
tags:
- ipam
patch:
operationId: ipam_roles_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Role'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Role'
tags:
- ipam
delete:
operationId: ipam_roles_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/roles/{id}/:
get:
operationId: ipam_roles_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Role'
tags:
- ipam
put:
operationId: ipam_roles_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Role'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Role'
tags:
- ipam
patch:
operationId: ipam_roles_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Role'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Role'
tags:
- ipam
delete:
operationId: ipam_roles_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this role.
required: true
type: integer
/ipam/route-targets/:
get:
operationId: ipam_route-targets_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: importing_vrf_id
in: query
description: ''
required: false
type: string
- name: importing_vrf
in: query
description: ''
required: false
type: string
- name: exporting_vrf_id
in: query
description: ''
required: false
type: string
- name: exporting_vrf
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: importing_vrf_id__n
in: query
description: ''
required: false
type: string
- name: importing_vrf__n
in: query
description: ''
required: false
type: string
- name: exporting_vrf_id__n
in: query
description: ''
required: false
type: string
- name: exporting_vrf__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
post:
operationId: ipam_route-targets_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRouteTarget'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
put:
operationId: ipam_route-targets_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRouteTarget'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
patch:
operationId: ipam_route-targets_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRouteTarget'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
delete:
operationId: ipam_route-targets_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/route-targets/{id}/:
get:
operationId: ipam_route-targets_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
put:
operationId: ipam_route-targets_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRouteTarget'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
patch:
operationId: ipam_route-targets_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableRouteTarget'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RouteTarget'
tags:
- ipam
delete:
operationId: ipam_route-targets_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this route target.
required: true
type: integer
/ipam/service-templates/:
get:
operationId: ipam_service-templates_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: protocol
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: port
in: query
description: ''
required: false
type: number
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: protocol__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
post:
operationId: ipam_service-templates_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableServiceTemplate'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
put:
operationId: ipam_service-templates_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableServiceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
patch:
operationId: ipam_service-templates_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableServiceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
delete:
operationId: ipam_service-templates_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/service-templates/{id}/:
get:
operationId: ipam_service-templates_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
put:
operationId: ipam_service-templates_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableServiceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
patch:
operationId: ipam_service-templates_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableServiceTemplate'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ServiceTemplate'
tags:
- ipam
delete:
operationId: ipam_service-templates_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this service template.
required: true
type: integer
/ipam/services/:
get:
operationId: ipam_services_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: protocol
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: virtual_machine_id
in: query
description: ''
required: false
type: string
- name: virtual_machine
in: query
description: ''
required: false
type: string
- name: ipaddress_id
in: query
description: ''
required: false
type: string
- name: ipaddress
in: query
description: ''
required: false
type: string
- name: port
in: query
description: ''
required: false
type: number
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: protocol__n
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: virtual_machine_id__n
in: query
description: ''
required: false
type: string
- name: virtual_machine__n
in: query
description: ''
required: false
type: string
- name: ipaddress_id__n
in: query
description: ''
required: false
type: string
- name: ipaddress__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Service'
tags:
- ipam
post:
operationId: ipam_services_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableService'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Service'
tags:
- ipam
put:
operationId: ipam_services_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableService'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Service'
tags:
- ipam
patch:
operationId: ipam_services_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableService'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Service'
tags:
- ipam
delete:
operationId: ipam_services_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/services/{id}/:
get:
operationId: ipam_services_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Service'
tags:
- ipam
put:
operationId: ipam_services_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableService'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Service'
tags:
- ipam
patch:
operationId: ipam_services_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableService'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Service'
tags:
- ipam
delete:
operationId: ipam_services_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this service.
required: true
type: integer
/ipam/vlan-groups/:
get:
operationId: ipam_vlan-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: min_vid
in: query
description: ''
required: false
type: string
- name: max_vid
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: scope_id
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: scope_type
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: number
- name: sitegroup
in: query
description: ''
required: false
type: number
- name: site
in: query
description: ''
required: false
type: number
- name: location
in: query
description: ''
required: false
type: number
- name: rack
in: query
description: ''
required: false
type: number
- name: clustergroup
in: query
description: ''
required: false
type: number
- name: cluster
in: query
description: ''
required: false
type: number
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: min_vid__n
in: query
description: ''
required: false
type: string
- name: min_vid__lte
in: query
description: ''
required: false
type: string
- name: min_vid__lt
in: query
description: ''
required: false
type: string
- name: min_vid__gte
in: query
description: ''
required: false
type: string
- name: min_vid__gt
in: query
description: ''
required: false
type: string
- name: max_vid__n
in: query
description: ''
required: false
type: string
- name: max_vid__lte
in: query
description: ''
required: false
type: string
- name: max_vid__lt
in: query
description: ''
required: false
type: string
- name: max_vid__gte
in: query
description: ''
required: false
type: string
- name: max_vid__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: scope_id__n
in: query
description: ''
required: false
type: string
- name: scope_id__lte
in: query
description: ''
required: false
type: string
- name: scope_id__lt
in: query
description: ''
required: false
type: string
- name: scope_id__gte
in: query
description: ''
required: false
type: string
- name: scope_id__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: scope_type__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
post:
operationId: ipam_vlan-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/VLANGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
put:
operationId: ipam_vlan-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/VLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
patch:
operationId: ipam_vlan-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/VLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
delete:
operationId: ipam_vlan-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/vlan-groups/{id}/:
get:
operationId: ipam_vlan-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
put:
operationId: ipam_vlan-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/VLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
patch:
operationId: ipam_vlan-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/VLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLANGroup'
tags:
- ipam
delete:
operationId: ipam_vlan-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN group.
required: true
type: integer
/ipam/vlan-groups/{id}/available-vlans/:
get:
operationId: ipam_vlan-groups_available-vlans_list
description: ''
parameters: []
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/AvailableVLAN'
tags:
- ipam
post:
operationId: ipam_vlan-groups_available-vlans_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCreateAvailableVLAN'
responses:
'201':
description: ''
schema:
type: array
items:
$ref: '#/definitions/VLAN'
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN.
required: true
type: integer
/ipam/vlans/:
get:
operationId: ipam_vlans_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: vid
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: available_on_device
in: query
description: ''
required: false
type: string
- name: available_on_virtualmachine
in: query
description: ''
required: false
type: string
- name: l2vpn_id
in: query
description: ''
required: false
type: string
- name: l2vpn
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: vid__n
in: query
description: ''
required: false
type: string
- name: vid__lte
in: query
description: ''
required: false
type: string
- name: vid__lt
in: query
description: ''
required: false
type: string
- name: vid__gte
in: query
description: ''
required: false
type: string
- name: vid__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: l2vpn_id__n
in: query
description: ''
required: false
type: string
- name: l2vpn__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/VLAN'
tags:
- ipam
post:
operationId: ipam_vlans_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVLAN'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/VLAN'
tags:
- ipam
put:
operationId: ipam_vlans_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLAN'
tags:
- ipam
patch:
operationId: ipam_vlans_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLAN'
tags:
- ipam
delete:
operationId: ipam_vlans_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/vlans/{id}/:
get:
operationId: ipam_vlans_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLAN'
tags:
- ipam
put:
operationId: ipam_vlans_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLAN'
tags:
- ipam
patch:
operationId: ipam_vlans_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VLAN'
tags:
- ipam
delete:
operationId: ipam_vlans_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this VLAN.
required: true
type: integer
/ipam/vrfs/:
get:
operationId: ipam_vrfs_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: rd
in: query
description: ''
required: false
type: string
- name: enforce_unique
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: import_target_id
in: query
description: ''
required: false
type: string
- name: import_target
in: query
description: ''
required: false
type: string
- name: export_target_id
in: query
description: ''
required: false
type: string
- name: export_target
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: rd__n
in: query
description: ''
required: false
type: string
- name: rd__ic
in: query
description: ''
required: false
type: string
- name: rd__nic
in: query
description: ''
required: false
type: string
- name: rd__iew
in: query
description: ''
required: false
type: string
- name: rd__niew
in: query
description: ''
required: false
type: string
- name: rd__isw
in: query
description: ''
required: false
type: string
- name: rd__nisw
in: query
description: ''
required: false
type: string
- name: rd__ie
in: query
description: ''
required: false
type: string
- name: rd__nie
in: query
description: ''
required: false
type: string
- name: rd__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: import_target_id__n
in: query
description: ''
required: false
type: string
- name: import_target__n
in: query
description: ''
required: false
type: string
- name: export_target_id__n
in: query
description: ''
required: false
type: string
- name: export_target__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/VRF'
tags:
- ipam
post:
operationId: ipam_vrfs_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVRF'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/VRF'
tags:
- ipam
put:
operationId: ipam_vrfs_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVRF'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VRF'
tags:
- ipam
patch:
operationId: ipam_vrfs_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVRF'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VRF'
tags:
- ipam
delete:
operationId: ipam_vrfs_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters: []
/ipam/vrfs/{id}/:
get:
operationId: ipam_vrfs_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VRF'
tags:
- ipam
put:
operationId: ipam_vrfs_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVRF'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VRF'
tags:
- ipam
patch:
operationId: ipam_vrfs_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVRF'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VRF'
tags:
- ipam
delete:
operationId: ipam_vrfs_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- ipam
parameters:
- name: id
in: path
description: A unique integer value identifying this VRF.
required: true
type: integer
/status/:
get:
operationId: status_list
description: A lightweight read-only endpoint for conveying NetBox's current
operational status.
parameters: []
responses:
'200':
description: ''
tags:
- status
parameters: []
/tenancy/contact-assignments/:
get:
operationId: tenancy_contact-assignments_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: content_type_id
in: query
description: ''
required: false
type: string
- name: object_id
in: query
description: ''
required: false
type: string
- name: priority
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: content_type
in: query
description: ''
required: false
type: string
- name: contact_id
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: content_type_id__n
in: query
description: ''
required: false
type: string
- name: object_id__n
in: query
description: ''
required: false
type: string
- name: object_id__lte
in: query
description: ''
required: false
type: string
- name: object_id__lt
in: query
description: ''
required: false
type: string
- name: object_id__gte
in: query
description: ''
required: false
type: string
- name: object_id__gt
in: query
description: ''
required: false
type: string
- name: priority__n
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: content_type__n
in: query
description: ''
required: false
type: string
- name: contact_id__n
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
post:
operationId: tenancy_contact-assignments_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactAssignment'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
put:
operationId: tenancy_contact-assignments_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
patch:
operationId: tenancy_contact-assignments_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
delete:
operationId: tenancy_contact-assignments_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters: []
/tenancy/contact-assignments/{id}/:
get:
operationId: tenancy_contact-assignments_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
put:
operationId: tenancy_contact-assignments_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
patch:
operationId: tenancy_contact-assignments_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactAssignment'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactAssignment'
tags:
- tenancy
delete:
operationId: tenancy_contact-assignments_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters:
- name: id
in: path
description: A unique integer value identifying this contact assignment.
required: true
type: integer
/tenancy/contact-groups/:
get:
operationId: tenancy_contact-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: parent
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: parent__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
post:
operationId: tenancy_contact-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
put:
operationId: tenancy_contact-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
patch:
operationId: tenancy_contact-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
delete:
operationId: tenancy_contact-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters: []
/tenancy/contact-groups/{id}/:
get:
operationId: tenancy_contact-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
put:
operationId: tenancy_contact-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
patch:
operationId: tenancy_contact-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContactGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactGroup'
tags:
- tenancy
delete:
operationId: tenancy_contact-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters:
- name: id
in: path
description: A unique integer value identifying this contact group.
required: true
type: integer
/tenancy/contact-roles/:
get:
operationId: tenancy_contact-roles_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
post:
operationId: tenancy_contact-roles_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ContactRole'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
put:
operationId: tenancy_contact-roles_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ContactRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
patch:
operationId: tenancy_contact-roles_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ContactRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
delete:
operationId: tenancy_contact-roles_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters: []
/tenancy/contact-roles/{id}/:
get:
operationId: tenancy_contact-roles_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
put:
operationId: tenancy_contact-roles_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ContactRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
patch:
operationId: tenancy_contact-roles_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ContactRole'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ContactRole'
tags:
- tenancy
delete:
operationId: tenancy_contact-roles_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters:
- name: id
in: path
description: A unique integer value identifying this contact role.
required: true
type: integer
/tenancy/contacts/:
get:
operationId: tenancy_contacts_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: title
in: query
description: ''
required: false
type: string
- name: phone
in: query
description: ''
required: false
type: string
- name: email
in: query
description: ''
required: false
type: string
- name: address
in: query
description: ''
required: false
type: string
- name: link
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: title__n
in: query
description: ''
required: false
type: string
- name: title__ic
in: query
description: ''
required: false
type: string
- name: title__nic
in: query
description: ''
required: false
type: string
- name: title__iew
in: query
description: ''
required: false
type: string
- name: title__niew
in: query
description: ''
required: false
type: string
- name: title__isw
in: query
description: ''
required: false
type: string
- name: title__nisw
in: query
description: ''
required: false
type: string
- name: title__ie
in: query
description: ''
required: false
type: string
- name: title__nie
in: query
description: ''
required: false
type: string
- name: title__empty
in: query
description: ''
required: false
type: string
- name: phone__n
in: query
description: ''
required: false
type: string
- name: phone__ic
in: query
description: ''
required: false
type: string
- name: phone__nic
in: query
description: ''
required: false
type: string
- name: phone__iew
in: query
description: ''
required: false
type: string
- name: phone__niew
in: query
description: ''
required: false
type: string
- name: phone__isw
in: query
description: ''
required: false
type: string
- name: phone__nisw
in: query
description: ''
required: false
type: string
- name: phone__ie
in: query
description: ''
required: false
type: string
- name: phone__nie
in: query
description: ''
required: false
type: string
- name: phone__empty
in: query
description: ''
required: false
type: string
- name: email__n
in: query
description: ''
required: false
type: string
- name: email__ic
in: query
description: ''
required: false
type: string
- name: email__nic
in: query
description: ''
required: false
type: string
- name: email__iew
in: query
description: ''
required: false
type: string
- name: email__niew
in: query
description: ''
required: false
type: string
- name: email__isw
in: query
description: ''
required: false
type: string
- name: email__nisw
in: query
description: ''
required: false
type: string
- name: email__ie
in: query
description: ''
required: false
type: string
- name: email__nie
in: query
description: ''
required: false
type: string
- name: email__empty
in: query
description: ''
required: false
type: string
- name: address__n
in: query
description: ''
required: false
type: string
- name: address__ic
in: query
description: ''
required: false
type: string
- name: address__nic
in: query
description: ''
required: false
type: string
- name: address__iew
in: query
description: ''
required: false
type: string
- name: address__niew
in: query
description: ''
required: false
type: string
- name: address__isw
in: query
description: ''
required: false
type: string
- name: address__nisw
in: query
description: ''
required: false
type: string
- name: address__ie
in: query
description: ''
required: false
type: string
- name: address__nie
in: query
description: ''
required: false
type: string
- name: address__empty
in: query
description: ''
required: false
type: string
- name: link__n
in: query
description: ''
required: false
type: string
- name: link__ic
in: query
description: ''
required: false
type: string
- name: link__nic
in: query
description: ''
required: false
type: string
- name: link__iew
in: query
description: ''
required: false
type: string
- name: link__niew
in: query
description: ''
required: false
type: string
- name: link__isw
in: query
description: ''
required: false
type: string
- name: link__nisw
in: query
description: ''
required: false
type: string
- name: link__ie
in: query
description: ''
required: false
type: string
- name: link__nie
in: query
description: ''
required: false
type: string
- name: link__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Contact'
tags:
- tenancy
post:
operationId: tenancy_contacts_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContact'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Contact'
tags:
- tenancy
put:
operationId: tenancy_contacts_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContact'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Contact'
tags:
- tenancy
patch:
operationId: tenancy_contacts_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContact'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Contact'
tags:
- tenancy
delete:
operationId: tenancy_contacts_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters: []
/tenancy/contacts/{id}/:
get:
operationId: tenancy_contacts_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Contact'
tags:
- tenancy
put:
operationId: tenancy_contacts_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContact'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Contact'
tags:
- tenancy
patch:
operationId: tenancy_contacts_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableContact'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Contact'
tags:
- tenancy
delete:
operationId: tenancy_contacts_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters:
- name: id
in: path
description: A unique integer value identifying this contact.
required: true
type: integer
/tenancy/tenant-groups/:
get:
operationId: tenancy_tenant-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: parent
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: parent__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
post:
operationId: tenancy_tenant-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenantGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
put:
operationId: tenancy_tenant-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenantGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
patch:
operationId: tenancy_tenant-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenantGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
delete:
operationId: tenancy_tenant-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters: []
/tenancy/tenant-groups/{id}/:
get:
operationId: tenancy_tenant-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
put:
operationId: tenancy_tenant-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenantGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
patch:
operationId: tenancy_tenant-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenantGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/TenantGroup'
tags:
- tenancy
delete:
operationId: tenancy_tenant-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant group.
required: true
type: integer
/tenancy/tenants/:
get:
operationId: tenancy_tenants_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Tenant'
tags:
- tenancy
post:
operationId: tenancy_tenants_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenant'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Tenant'
tags:
- tenancy
put:
operationId: tenancy_tenants_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenant'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tenant'
tags:
- tenancy
patch:
operationId: tenancy_tenants_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenant'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tenant'
tags:
- tenancy
delete:
operationId: tenancy_tenants_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters: []
/tenancy/tenants/{id}/:
get:
operationId: tenancy_tenants_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tenant'
tags:
- tenancy
put:
operationId: tenancy_tenants_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenant'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tenant'
tags:
- tenancy
patch:
operationId: tenancy_tenants_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableTenant'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Tenant'
tags:
- tenancy
delete:
operationId: tenancy_tenants_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- tenancy
parameters:
- name: id
in: path
description: A unique integer value identifying this tenant.
required: true
type: integer
/users/config/:
get:
operationId: users_config_list
description: Return the UserConfig for the currently authenticated User.
parameters: []
responses:
'200':
description: ''
tags:
- users
parameters: []
/users/groups/:
get:
operationId: users_groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Group'
tags:
- users
post:
operationId: users_groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- users
put:
operationId: users_groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- users
patch:
operationId: users_groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- users
delete:
operationId: users_groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters: []
/users/groups/{id}/:
get:
operationId: users_groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- users
put:
operationId: users_groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- users
patch:
operationId: users_groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- users
delete:
operationId: users_groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters:
- name: id
in: path
description: A unique integer value identifying this group.
required: true
type: integer
/users/permissions/:
get:
operationId: users_permissions_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: object_types
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: user_id
in: query
description: ''
required: false
type: string
- name: user
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: object_types__n
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: user_id__n
in: query
description: ''
required: false
type: string
- name: user__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ObjectPermission'
tags:
- users
post:
operationId: users_permissions_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableObjectPermission'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ObjectPermission'
tags:
- users
put:
operationId: users_permissions_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableObjectPermission'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ObjectPermission'
tags:
- users
patch:
operationId: users_permissions_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableObjectPermission'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ObjectPermission'
tags:
- users
delete:
operationId: users_permissions_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters: []
/users/permissions/{id}/:
get:
operationId: users_permissions_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ObjectPermission'
tags:
- users
put:
operationId: users_permissions_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableObjectPermission'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ObjectPermission'
tags:
- users
patch:
operationId: users_permissions_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableObjectPermission'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ObjectPermission'
tags:
- users
delete:
operationId: users_permissions_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters:
- name: id
in: path
description: A unique integer value identifying this permission.
required: true
type: integer
/users/tokens/:
get:
operationId: users_tokens_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: key
in: query
description: ''
required: false
type: string
- name: write_enabled
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: user_id
in: query
description: ''
required: false
type: string
- name: user
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: expires
in: query
description: ''
required: false
type: string
- name: expires__gte
in: query
description: ''
required: false
type: string
- name: expires__lte
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: key__n
in: query
description: ''
required: false
type: string
- name: key__ic
in: query
description: ''
required: false
type: string
- name: key__nic
in: query
description: ''
required: false
type: string
- name: key__iew
in: query
description: ''
required: false
type: string
- name: key__niew
in: query
description: ''
required: false
type: string
- name: key__isw
in: query
description: ''
required: false
type: string
- name: key__nisw
in: query
description: ''
required: false
type: string
- name: key__ie
in: query
description: ''
required: false
type: string
- name: key__nie
in: query
description: ''
required: false
type: string
- name: key__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: user_id__n
in: query
description: ''
required: false
type: string
- name: user__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Token'
tags:
- users
post:
operationId: users_tokens_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableToken'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Token'
tags:
- users
put:
operationId: users_tokens_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableToken'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Token'
tags:
- users
patch:
operationId: users_tokens_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableToken'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Token'
tags:
- users
delete:
operationId: users_tokens_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters: []
/users/tokens/provision/:
post:
operationId: users_tokens_provision_create
description: Non-authenticated REST API endpoint via which a user may create
a Token.
parameters: []
responses:
'201':
description: ''
tags:
- users
parameters: []
/users/tokens/{id}/:
get:
operationId: users_tokens_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Token'
tags:
- users
put:
operationId: users_tokens_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableToken'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Token'
tags:
- users
patch:
operationId: users_tokens_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableToken'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Token'
tags:
- users
delete:
operationId: users_tokens_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters:
- name: id
in: path
description: A unique integer value identifying this token.
required: true
type: integer
/users/users/:
get:
operationId: users_users_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: username
in: query
description: ''
required: false
type: string
- name: first_name
in: query
description: ''
required: false
type: string
- name: last_name
in: query
description: ''
required: false
type: string
- name: email
in: query
description: ''
required: false
type: string
- name: is_staff
in: query
description: ''
required: false
type: string
- name: is_active
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: username__n
in: query
description: ''
required: false
type: string
- name: username__ic
in: query
description: ''
required: false
type: string
- name: username__nic
in: query
description: ''
required: false
type: string
- name: username__iew
in: query
description: ''
required: false
type: string
- name: username__niew
in: query
description: ''
required: false
type: string
- name: username__isw
in: query
description: ''
required: false
type: string
- name: username__nisw
in: query
description: ''
required: false
type: string
- name: username__ie
in: query
description: ''
required: false
type: string
- name: username__nie
in: query
description: ''
required: false
type: string
- name: username__empty
in: query
description: ''
required: false
type: string
- name: first_name__n
in: query
description: ''
required: false
type: string
- name: first_name__ic
in: query
description: ''
required: false
type: string
- name: first_name__nic
in: query
description: ''
required: false
type: string
- name: first_name__iew
in: query
description: ''
required: false
type: string
- name: first_name__niew
in: query
description: ''
required: false
type: string
- name: first_name__isw
in: query
description: ''
required: false
type: string
- name: first_name__nisw
in: query
description: ''
required: false
type: string
- name: first_name__ie
in: query
description: ''
required: false
type: string
- name: first_name__nie
in: query
description: ''
required: false
type: string
- name: first_name__empty
in: query
description: ''
required: false
type: string
- name: last_name__n
in: query
description: ''
required: false
type: string
- name: last_name__ic
in: query
description: ''
required: false
type: string
- name: last_name__nic
in: query
description: ''
required: false
type: string
- name: last_name__iew
in: query
description: ''
required: false
type: string
- name: last_name__niew
in: query
description: ''
required: false
type: string
- name: last_name__isw
in: query
description: ''
required: false
type: string
- name: last_name__nisw
in: query
description: ''
required: false
type: string
- name: last_name__ie
in: query
description: ''
required: false
type: string
- name: last_name__nie
in: query
description: ''
required: false
type: string
- name: last_name__empty
in: query
description: ''
required: false
type: string
- name: email__n
in: query
description: ''
required: false
type: string
- name: email__ic
in: query
description: ''
required: false
type: string
- name: email__nic
in: query
description: ''
required: false
type: string
- name: email__iew
in: query
description: ''
required: false
type: string
- name: email__niew
in: query
description: ''
required: false
type: string
- name: email__isw
in: query
description: ''
required: false
type: string
- name: email__nisw
in: query
description: ''
required: false
type: string
- name: email__ie
in: query
description: ''
required: false
type: string
- name: email__nie
in: query
description: ''
required: false
type: string
- name: email__empty
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/User'
tags:
- users
post:
operationId: users_users_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableUser'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- users
put:
operationId: users_users_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableUser'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- users
patch:
operationId: users_users_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableUser'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- users
delete:
operationId: users_users_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters: []
/users/users/{id}/:
get:
operationId: users_users_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- users
put:
operationId: users_users_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableUser'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- users
patch:
operationId: users_users_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableUser'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- users
delete:
operationId: users_users_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- users
parameters:
- name: id
in: path
description: A unique integer value identifying this user.
required: true
type: integer
/virtualization/cluster-groups/:
get:
operationId: virtualization_cluster-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
post:
operationId: virtualization_cluster-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
put:
operationId: virtualization_cluster-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
patch:
operationId: virtualization_cluster-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
delete:
operationId: virtualization_cluster-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters: []
/virtualization/cluster-groups/{id}/:
get:
operationId: virtualization_cluster-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
put:
operationId: virtualization_cluster-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
patch:
operationId: virtualization_cluster-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterGroup'
tags:
- virtualization
delete:
operationId: virtualization_cluster-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster group.
required: true
type: integer
/virtualization/cluster-types/:
get:
operationId: virtualization_cluster-types_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
post:
operationId: virtualization_cluster-types_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterType'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
put:
operationId: virtualization_cluster-types_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
patch:
operationId: virtualization_cluster-types_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
delete:
operationId: virtualization_cluster-types_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters: []
/virtualization/cluster-types/{id}/:
get:
operationId: virtualization_cluster-types_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
put:
operationId: virtualization_cluster-types_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
patch:
operationId: virtualization_cluster-types_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ClusterType'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ClusterType'
tags:
- virtualization
delete:
operationId: virtualization_cluster-types_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster type.
required: true
type: integer
/virtualization/clusters/:
get:
operationId: virtualization_clusters_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: type_id
in: query
description: ''
required: false
type: string
- name: type
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: type_id__n
in: query
description: ''
required: false
type: string
- name: type__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Cluster'
tags:
- virtualization
post:
operationId: virtualization_clusters_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCluster'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Cluster'
tags:
- virtualization
put:
operationId: virtualization_clusters_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCluster'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cluster'
tags:
- virtualization
patch:
operationId: virtualization_clusters_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCluster'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cluster'
tags:
- virtualization
delete:
operationId: virtualization_clusters_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters: []
/virtualization/clusters/{id}/:
get:
operationId: virtualization_clusters_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cluster'
tags:
- virtualization
put:
operationId: virtualization_clusters_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCluster'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cluster'
tags:
- virtualization
patch:
operationId: virtualization_clusters_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableCluster'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Cluster'
tags:
- virtualization
delete:
operationId: virtualization_clusters_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters:
- name: id
in: path
description: A unique integer value identifying this cluster.
required: true
type: integer
/virtualization/interfaces/:
get:
operationId: virtualization_interfaces_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: enabled
in: query
description: ''
required: false
type: string
- name: mtu
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: cluster_id
in: query
description: ''
required: false
type: string
- name: cluster
in: query
description: ''
required: false
type: string
- name: virtual_machine_id
in: query
description: ''
required: false
type: string
- name: virtual_machine
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: bridge_id
in: query
description: ''
required: false
type: string
- name: mac_address
in: query
description: ''
required: false
type: string
- name: vrf_id
in: query
description: ''
required: false
type: string
- name: vrf
in: query
description: ''
required: false
type: string
- name: l2vpn_id
in: query
description: ''
required: false
type: string
- name: l2vpn
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: mtu__n
in: query
description: ''
required: false
type: string
- name: mtu__lte
in: query
description: ''
required: false
type: string
- name: mtu__lt
in: query
description: ''
required: false
type: string
- name: mtu__gte
in: query
description: ''
required: false
type: string
- name: mtu__gt
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: cluster_id__n
in: query
description: ''
required: false
type: string
- name: cluster__n
in: query
description: ''
required: false
type: string
- name: virtual_machine_id__n
in: query
description: ''
required: false
type: string
- name: virtual_machine__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: bridge_id__n
in: query
description: ''
required: false
type: string
- name: mac_address__n
in: query
description: ''
required: false
type: string
- name: mac_address__ic
in: query
description: ''
required: false
type: string
- name: mac_address__nic
in: query
description: ''
required: false
type: string
- name: mac_address__iew
in: query
description: ''
required: false
type: string
- name: mac_address__niew
in: query
description: ''
required: false
type: string
- name: mac_address__isw
in: query
description: ''
required: false
type: string
- name: mac_address__nisw
in: query
description: ''
required: false
type: string
- name: mac_address__ie
in: query
description: ''
required: false
type: string
- name: mac_address__nie
in: query
description: ''
required: false
type: string
- name: vrf_id__n
in: query
description: ''
required: false
type: string
- name: vrf__n
in: query
description: ''
required: false
type: string
- name: l2vpn_id__n
in: query
description: ''
required: false
type: string
- name: l2vpn__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
post:
operationId: virtualization_interfaces_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVMInterface'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
put:
operationId: virtualization_interfaces_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVMInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
patch:
operationId: virtualization_interfaces_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVMInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
delete:
operationId: virtualization_interfaces_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters: []
/virtualization/interfaces/{id}/:
get:
operationId: virtualization_interfaces_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
put:
operationId: virtualization_interfaces_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVMInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
patch:
operationId: virtualization_interfaces_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableVMInterface'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/VMInterface'
tags:
- virtualization
delete:
operationId: virtualization_interfaces_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters:
- name: id
in: path
description: A unique integer value identifying this interface.
required: true
type: integer
/virtualization/virtual-machines/:
get:
operationId: virtualization_virtual-machines_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: cluster
in: query
description: ''
required: false
type: string
- name: vcpus
in: query
description: ''
required: false
type: string
- name: memory
in: query
description: ''
required: false
type: string
- name: disk
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: contact
in: query
description: ''
required: false
type: string
- name: contact_role
in: query
description: ''
required: false
type: string
- name: contact_group
in: query
description: ''
required: false
type: string
- name: local_context_data
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: cluster_group_id
in: query
description: ''
required: false
type: string
- name: cluster_group
in: query
description: ''
required: false
type: string
- name: cluster_type_id
in: query
description: ''
required: false
type: string
- name: cluster_type
in: query
description: ''
required: false
type: string
- name: cluster_id
in: query
description: ''
required: false
type: string
- name: device_id
in: query
description: ''
required: false
type: string
- name: device
in: query
description: ''
required: false
type: string
- name: region_id
in: query
description: ''
required: false
type: string
- name: region
in: query
description: ''
required: false
type: string
- name: site_group_id
in: query
description: ''
required: false
type: string
- name: site_group
in: query
description: ''
required: false
type: string
- name: site_id
in: query
description: ''
required: false
type: string
- name: site
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: role_id
in: query
description: ''
required: false
type: string
- name: role
in: query
description: ''
required: false
type: string
- name: platform_id
in: query
description: ''
required: false
type: string
- name: platform
in: query
description: ''
required: false
type: string
- name: mac_address
in: query
description: ''
required: false
type: string
- name: has_primary_ip
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: cluster__n
in: query
description: ''
required: false
type: string
- name: vcpus__n
in: query
description: ''
required: false
type: string
- name: vcpus__lte
in: query
description: ''
required: false
type: string
- name: vcpus__lt
in: query
description: ''
required: false
type: string
- name: vcpus__gte
in: query
description: ''
required: false
type: string
- name: vcpus__gt
in: query
description: ''
required: false
type: string
- name: memory__n
in: query
description: ''
required: false
type: string
- name: memory__lte
in: query
description: ''
required: false
type: string
- name: memory__lt
in: query
description: ''
required: false
type: string
- name: memory__gte
in: query
description: ''
required: false
type: string
- name: memory__gt
in: query
description: ''
required: false
type: string
- name: disk__n
in: query
description: ''
required: false
type: string
- name: disk__lte
in: query
description: ''
required: false
type: string
- name: disk__lt
in: query
description: ''
required: false
type: string
- name: disk__gte
in: query
description: ''
required: false
type: string
- name: disk__gt
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: contact__n
in: query
description: ''
required: false
type: string
- name: contact_role__n
in: query
description: ''
required: false
type: string
- name: contact_group__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: cluster_group_id__n
in: query
description: ''
required: false
type: string
- name: cluster_group__n
in: query
description: ''
required: false
type: string
- name: cluster_type_id__n
in: query
description: ''
required: false
type: string
- name: cluster_type__n
in: query
description: ''
required: false
type: string
- name: cluster_id__n
in: query
description: ''
required: false
type: string
- name: device_id__n
in: query
description: ''
required: false
type: string
- name: device__n
in: query
description: ''
required: false
type: string
- name: region_id__n
in: query
description: ''
required: false
type: string
- name: region__n
in: query
description: ''
required: false
type: string
- name: site_group_id__n
in: query
description: ''
required: false
type: string
- name: site_group__n
in: query
description: ''
required: false
type: string
- name: site_id__n
in: query
description: ''
required: false
type: string
- name: site__n
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: role_id__n
in: query
description: ''
required: false
type: string
- name: role__n
in: query
description: ''
required: false
type: string
- name: platform_id__n
in: query
description: ''
required: false
type: string
- name: platform__n
in: query
description: ''
required: false
type: string
- name: mac_address__n
in: query
description: ''
required: false
type: string
- name: mac_address__ic
in: query
description: ''
required: false
type: string
- name: mac_address__nic
in: query
description: ''
required: false
type: string
- name: mac_address__iew
in: query
description: ''
required: false
type: string
- name: mac_address__niew
in: query
description: ''
required: false
type: string
- name: mac_address__isw
in: query
description: ''
required: false
type: string
- name: mac_address__nisw
in: query
description: ''
required: false
type: string
- name: mac_address__ie
in: query
description: ''
required: false
type: string
- name: mac_address__nie
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
tags:
- virtualization
post:
operationId: virtualization_virtual-machines_create
description: ''
parameters: []
responses:
'201':
description: ''
tags:
- virtualization
put:
operationId: virtualization_virtual-machines_bulk_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- virtualization
patch:
operationId: virtualization_virtual-machines_bulk_partial_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- virtualization
delete:
operationId: virtualization_virtual-machines_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters: []
/virtualization/virtual-machines/{id}/:
get:
operationId: virtualization_virtual-machines_read
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- virtualization
put:
operationId: virtualization_virtual-machines_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- virtualization
patch:
operationId: virtualization_virtual-machines_partial_update
description: ''
parameters: []
responses:
'200':
description: ''
tags:
- virtualization
delete:
operationId: virtualization_virtual-machines_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- virtualization
parameters:
- name: id
in: path
description: A unique integer value identifying this virtual machine.
required: true
type: integer
/wireless/wireless-lan-groups/:
get:
operationId: wireless_wireless-lan-groups_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: name
in: query
description: ''
required: false
type: string
- name: slug
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: parent_id
in: query
description: ''
required: false
type: string
- name: parent
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: name__n
in: query
description: ''
required: false
type: string
- name: name__ic
in: query
description: ''
required: false
type: string
- name: name__nic
in: query
description: ''
required: false
type: string
- name: name__iew
in: query
description: ''
required: false
type: string
- name: name__niew
in: query
description: ''
required: false
type: string
- name: name__isw
in: query
description: ''
required: false
type: string
- name: name__nisw
in: query
description: ''
required: false
type: string
- name: name__ie
in: query
description: ''
required: false
type: string
- name: name__nie
in: query
description: ''
required: false
type: string
- name: name__empty
in: query
description: ''
required: false
type: string
- name: slug__n
in: query
description: ''
required: false
type: string
- name: slug__ic
in: query
description: ''
required: false
type: string
- name: slug__nic
in: query
description: ''
required: false
type: string
- name: slug__iew
in: query
description: ''
required: false
type: string
- name: slug__niew
in: query
description: ''
required: false
type: string
- name: slug__isw
in: query
description: ''
required: false
type: string
- name: slug__nisw
in: query
description: ''
required: false
type: string
- name: slug__ie
in: query
description: ''
required: false
type: string
- name: slug__nie
in: query
description: ''
required: false
type: string
- name: slug__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: parent_id__n
in: query
description: ''
required: false
type: string
- name: parent__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
post:
operationId: wireless_wireless-lan-groups_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLANGroup'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
put:
operationId: wireless_wireless-lan-groups_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
patch:
operationId: wireless_wireless-lan-groups_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
delete:
operationId: wireless_wireless-lan-groups_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- wireless
parameters: []
/wireless/wireless-lan-groups/{id}/:
get:
operationId: wireless_wireless-lan-groups_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
put:
operationId: wireless_wireless-lan-groups_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
patch:
operationId: wireless_wireless-lan-groups_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLANGroup'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLANGroup'
tags:
- wireless
delete:
operationId: wireless_wireless-lan-groups_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- wireless
parameters:
- name: id
in: path
description: A unique integer value identifying this Wireless LAN Group.
required: true
type: integer
/wireless/wireless-lans/:
get:
operationId: wireless_wireless-lans_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: ssid
in: query
description: ''
required: false
type: string
- name: auth_psk
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: group_id
in: query
description: ''
required: false
type: string
- name: group
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: vlan_id
in: query
description: ''
required: false
type: string
- name: auth_type
in: query
description: ''
required: false
type: string
- name: auth_cipher
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: ssid__n
in: query
description: ''
required: false
type: string
- name: ssid__ic
in: query
description: ''
required: false
type: string
- name: ssid__nic
in: query
description: ''
required: false
type: string
- name: ssid__iew
in: query
description: ''
required: false
type: string
- name: ssid__niew
in: query
description: ''
required: false
type: string
- name: ssid__isw
in: query
description: ''
required: false
type: string
- name: ssid__nisw
in: query
description: ''
required: false
type: string
- name: ssid__ie
in: query
description: ''
required: false
type: string
- name: ssid__nie
in: query
description: ''
required: false
type: string
- name: ssid__empty
in: query
description: ''
required: false
type: string
- name: auth_psk__n
in: query
description: ''
required: false
type: string
- name: auth_psk__ic
in: query
description: ''
required: false
type: string
- name: auth_psk__nic
in: query
description: ''
required: false
type: string
- name: auth_psk__iew
in: query
description: ''
required: false
type: string
- name: auth_psk__niew
in: query
description: ''
required: false
type: string
- name: auth_psk__isw
in: query
description: ''
required: false
type: string
- name: auth_psk__nisw
in: query
description: ''
required: false
type: string
- name: auth_psk__ie
in: query
description: ''
required: false
type: string
- name: auth_psk__nie
in: query
description: ''
required: false
type: string
- name: auth_psk__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: group_id__n
in: query
description: ''
required: false
type: string
- name: group__n
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: vlan_id__n
in: query
description: ''
required: false
type: string
- name: auth_type__n
in: query
description: ''
required: false
type: string
- name: auth_cipher__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
post:
operationId: wireless_wireless-lans_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLAN'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
put:
operationId: wireless_wireless-lans_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
patch:
operationId: wireless_wireless-lans_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
delete:
operationId: wireless_wireless-lans_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- wireless
parameters: []
/wireless/wireless-lans/{id}/:
get:
operationId: wireless_wireless-lans_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
put:
operationId: wireless_wireless-lans_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
patch:
operationId: wireless_wireless-lans_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLAN'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLAN'
tags:
- wireless
delete:
operationId: wireless_wireless-lans_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- wireless
parameters:
- name: id
in: path
description: A unique integer value identifying this Wireless LAN.
required: true
type: integer
/wireless/wireless-links/:
get:
operationId: wireless_wireless-links_list
description: ''
parameters:
- name: id
in: query
description: ''
required: false
type: string
- name: ssid
in: query
description: ''
required: false
type: string
- name: auth_psk
in: query
description: ''
required: false
type: string
- name: description
in: query
description: ''
required: false
type: string
- name: created
in: query
description: ''
required: false
type: string
- name: last_updated
in: query
description: ''
required: false
type: string
- name: created_by_request
in: query
description: ''
required: false
type: string
- name: updated_by_request
in: query
description: ''
required: false
type: string
- name: q
in: query
description: ''
required: false
type: string
- name: tag
in: query
description: ''
required: false
type: string
- name: tenant_group_id
in: query
description: ''
required: false
type: string
- name: tenant_group
in: query
description: ''
required: false
type: string
- name: tenant_id
in: query
description: ''
required: false
type: string
- name: tenant
in: query
description: ''
required: false
type: string
- name: interface_a_id
in: query
description: ''
required: false
type: string
- name: interface_b_id
in: query
description: ''
required: false
type: string
- name: status
in: query
description: ''
required: false
type: string
- name: auth_type
in: query
description: ''
required: false
type: string
- name: auth_cipher
in: query
description: ''
required: false
type: string
- name: id__n
in: query
description: ''
required: false
type: string
- name: id__lte
in: query
description: ''
required: false
type: string
- name: id__lt
in: query
description: ''
required: false
type: string
- name: id__gte
in: query
description: ''
required: false
type: string
- name: id__gt
in: query
description: ''
required: false
type: string
- name: ssid__n
in: query
description: ''
required: false
type: string
- name: ssid__ic
in: query
description: ''
required: false
type: string
- name: ssid__nic
in: query
description: ''
required: false
type: string
- name: ssid__iew
in: query
description: ''
required: false
type: string
- name: ssid__niew
in: query
description: ''
required: false
type: string
- name: ssid__isw
in: query
description: ''
required: false
type: string
- name: ssid__nisw
in: query
description: ''
required: false
type: string
- name: ssid__ie
in: query
description: ''
required: false
type: string
- name: ssid__nie
in: query
description: ''
required: false
type: string
- name: ssid__empty
in: query
description: ''
required: false
type: string
- name: auth_psk__n
in: query
description: ''
required: false
type: string
- name: auth_psk__ic
in: query
description: ''
required: false
type: string
- name: auth_psk__nic
in: query
description: ''
required: false
type: string
- name: auth_psk__iew
in: query
description: ''
required: false
type: string
- name: auth_psk__niew
in: query
description: ''
required: false
type: string
- name: auth_psk__isw
in: query
description: ''
required: false
type: string
- name: auth_psk__nisw
in: query
description: ''
required: false
type: string
- name: auth_psk__ie
in: query
description: ''
required: false
type: string
- name: auth_psk__nie
in: query
description: ''
required: false
type: string
- name: auth_psk__empty
in: query
description: ''
required: false
type: string
- name: description__n
in: query
description: ''
required: false
type: string
- name: description__ic
in: query
description: ''
required: false
type: string
- name: description__nic
in: query
description: ''
required: false
type: string
- name: description__iew
in: query
description: ''
required: false
type: string
- name: description__niew
in: query
description: ''
required: false
type: string
- name: description__isw
in: query
description: ''
required: false
type: string
- name: description__nisw
in: query
description: ''
required: false
type: string
- name: description__ie
in: query
description: ''
required: false
type: string
- name: description__nie
in: query
description: ''
required: false
type: string
- name: description__empty
in: query
description: ''
required: false
type: string
- name: created__n
in: query
description: ''
required: false
type: string
- name: created__lte
in: query
description: ''
required: false
type: string
- name: created__lt
in: query
description: ''
required: false
type: string
- name: created__gte
in: query
description: ''
required: false
type: string
- name: created__gt
in: query
description: ''
required: false
type: string
- name: last_updated__n
in: query
description: ''
required: false
type: string
- name: last_updated__lte
in: query
description: ''
required: false
type: string
- name: last_updated__lt
in: query
description: ''
required: false
type: string
- name: last_updated__gte
in: query
description: ''
required: false
type: string
- name: last_updated__gt
in: query
description: ''
required: false
type: string
- name: tag__n
in: query
description: ''
required: false
type: string
- name: tenant_group_id__n
in: query
description: ''
required: false
type: string
- name: tenant_group__n
in: query
description: ''
required: false
type: string
- name: tenant_id__n
in: query
description: ''
required: false
type: string
- name: tenant__n
in: query
description: ''
required: false
type: string
- name: interface_a_id__n
in: query
description: ''
required: false
type: string
- name: interface_a_id__lte
in: query
description: ''
required: false
type: string
- name: interface_a_id__lt
in: query
description: ''
required: false
type: string
- name: interface_a_id__gte
in: query
description: ''
required: false
type: string
- name: interface_a_id__gt
in: query
description: ''
required: false
type: string
- name: interface_b_id__n
in: query
description: ''
required: false
type: string
- name: interface_b_id__lte
in: query
description: ''
required: false
type: string
- name: interface_b_id__lt
in: query
description: ''
required: false
type: string
- name: interface_b_id__gte
in: query
description: ''
required: false
type: string
- name: interface_b_id__gt
in: query
description: ''
required: false
type: string
- name: status__n
in: query
description: ''
required: false
type: string
- name: auth_type__n
in: query
description: ''
required: false
type: string
- name: auth_cipher__n
in: query
description: ''
required: false
type: string
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
post:
operationId: wireless_wireless-links_create
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLink'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
put:
operationId: wireless_wireless-links_bulk_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
patch:
operationId: wireless_wireless-links_bulk_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
delete:
operationId: wireless_wireless-links_bulk_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- wireless
parameters: []
/wireless/wireless-links/{id}/:
get:
operationId: wireless_wireless-links_read
description: ''
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
put:
operationId: wireless_wireless-links_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
patch:
operationId: wireless_wireless-links_partial_update
description: ''
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/WritableWirelessLink'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WirelessLink'
tags:
- wireless
delete:
operationId: wireless_wireless-links_delete
description: ''
parameters: []
responses:
'204':
description: ''
tags:
- wireless
parameters:
- name: id
in: path
description: A unique integer value identifying this wireless link.
required: true
type: integer
definitions:
NestedCircuit:
required:
- cid
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
cid:
title: Circuit ID
description: Unique circuit ID
type: string
maxLength: 100
minLength: 1
NestedSite:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Full name of the site
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
x-nullable: true
NestedProviderNetwork:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
x-nullable: true
NestedCable:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
label:
title: Label
type: string
maxLength: 100
NestedTag:
required:
- name
- slug
type: object
properties:
id:
title: Id
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
maxLength: 100
minLength: 1
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
minLength: 1
CircuitTermination:
required:
- circuit
- term_side
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
circuit:
$ref: '#/definitions/NestedCircuit'
term_side:
title: Termination
type: string
enum:
- A
- Z
site:
$ref: '#/definitions/NestedSite'
provider_network:
$ref: '#/definitions/NestedProviderNetwork'
port_speed:
title: Port speed (Kbps)
description: Physical circuit speed
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
upstream_speed:
title: Upstream speed (Kbps)
description: Upstream speed, if different from port speed
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
xconnect_id:
title: Cross-connect ID
description: ID of the local cross-connect
type: string
maxLength: 50
pp_info:
title: Patch panel/port(s)
description: Patch panel ID and port number(s)
type: string
maxLength: 100
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritableCircuitTermination:
required:
- circuit
- term_side
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
circuit:
title: Circuit
type: integer
term_side:
title: Termination
type: string
enum:
- A
- Z
site:
title: Site
type: integer
x-nullable: true
provider_network:
title: Provider network
type: integer
x-nullable: true
port_speed:
title: Port speed (Kbps)
description: Physical circuit speed
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
upstream_speed:
title: Upstream speed (Kbps)
description: Upstream speed, if different from port speed
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
xconnect_id:
title: Cross-connect ID
description: ID of the local cross-connect
type: string
maxLength: 50
pp_info:
title: Patch panel/port(s)
description: Patch panel ID and port number(s)
type: string
maxLength: 100
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
CircuitType:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
NestedProvider:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Full name of the provider
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
circuit_count:
title: Circuit count
type: integer
readOnly: true
NestedProviderAccount:
required:
- account
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
account:
title: Account ID
type: string
maxLength: 100
minLength: 1
NestedCircuitType:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
circuit_count:
title: Circuit count
type: integer
readOnly: true
NestedTenant:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
x-nullable: true
CircuitCircuitTermination:
required:
- site
- provider_network
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
site:
$ref: '#/definitions/NestedSite'
provider_network:
$ref: '#/definitions/NestedProviderNetwork'
port_speed:
title: Port speed (Kbps)
description: Physical circuit speed
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
upstream_speed:
title: Upstream speed (Kbps)
description: Upstream speed, if different from port speed
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
xconnect_id:
title: Cross-connect ID
description: ID of the local cross-connect
type: string
maxLength: 50
description:
title: Description
type: string
maxLength: 200
Circuit:
required:
- cid
- provider
- provider_account
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
cid:
title: Circuit ID
description: Unique circuit ID
type: string
maxLength: 100
minLength: 1
provider:
$ref: '#/definitions/NestedProvider'
provider_account:
$ref: '#/definitions/NestedProviderAccount'
type:
$ref: '#/definitions/NestedCircuitType'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Planned
- Provisioning
- Active
- Offline
- Deprovisioning
- Decommissioned
value:
type: string
enum:
- planned
- provisioning
- active
- offline
- deprovisioning
- decommissioned
tenant:
$ref: '#/definitions/NestedTenant'
install_date:
title: Installed
type: string
format: date
x-nullable: true
termination_date:
title: Terminates
type: string
format: date
x-nullable: true
commit_rate:
title: Commit rate (Kbps)
description: Committed rate
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
description:
title: Description
type: string
maxLength: 200
termination_a:
$ref: '#/definitions/CircuitCircuitTermination'
termination_z:
$ref: '#/definitions/CircuitCircuitTermination'
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableCircuit:
required:
- cid
- provider
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
cid:
title: Circuit ID
description: Unique circuit ID
type: string
maxLength: 100
minLength: 1
provider:
title: Provider
type: integer
provider_account:
title: Provider account
type: integer
x-nullable: true
type:
title: Type
type: integer
status:
title: Status
type: string
enum:
- planned
- provisioning
- active
- offline
- deprovisioning
- decommissioned
tenant:
title: Tenant
type: integer
x-nullable: true
install_date:
title: Installed
type: string
format: date
x-nullable: true
termination_date:
title: Terminates
type: string
format: date
x-nullable: true
commit_rate:
title: Commit rate (Kbps)
description: Committed rate
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
description:
title: Description
type: string
maxLength: 200
termination_a:
title: Termination a
type: integer
readOnly: true
x-nullable: true
termination_z:
title: Termination z
type: integer
readOnly: true
x-nullable: true
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ProviderAccount:
required:
- provider
- account
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
provider:
$ref: '#/definitions/NestedProvider'
name:
title: Name
type: string
maxLength: 100
account:
title: Account ID
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableProviderAccount:
required:
- provider
- account
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
provider:
title: Provider
type: integer
name:
title: Name
type: string
maxLength: 100
account:
title: Account ID
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ProviderNetwork:
required:
- provider
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
provider:
$ref: '#/definitions/NestedProvider'
name:
title: Name
type: string
maxLength: 100
minLength: 1
service_id:
title: Service ID
type: string
maxLength: 100
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableProviderNetwork:
required:
- provider
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
provider:
title: Provider
type: integer
name:
title: Name
type: string
maxLength: 100
minLength: 1
service_id:
title: Service ID
type: string
maxLength: 100
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedASN:
required:
- asn
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
asn:
title: ASN
description: 16- or 32-bit autonomous system number
type: integer
maximum: 4294967295
minimum: 1
Provider:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Full name of the provider
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
accounts:
type: array
items:
$ref: '#/definitions/NestedProviderAccount'
uniqueItems: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
asns:
type: array
items:
$ref: '#/definitions/NestedASN'
uniqueItems: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
WritableProvider:
required:
- name
- slug
- accounts
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Full name of the provider
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
accounts:
type: array
items:
type: integer
uniqueItems: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
asns:
type: array
items:
type: integer
uniqueItems: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
NestedDataSource:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
DataFile:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
source:
$ref: '#/definitions/NestedDataSource'
path:
title: Path
description: File path relative to the data source's root
type: string
readOnly: true
minLength: 1
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
size:
title: Size
type: integer
readOnly: true
hash:
title: Hash
description: SHA256 hash of the file data
type: string
readOnly: true
minLength: 1
DataSource:
required:
- name
- type
- source_url
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Local
- Git
- Amazon S3
value:
type: string
enum:
- local
- git
- amazon-s3
source_url:
title: URL
type: string
maxLength: 200
minLength: 1
enabled:
title: Enabled
type: boolean
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- New
- Queued
- Syncing
- Completed
- Failed
value:
type: string
enum:
- new
- queued
- syncing
- completed
- failed
readOnly: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
parameters:
title: Parameters
type: object
x-nullable: true
ignore_rules:
title: Ignore rules
description: Patterns (one per line) matching files to ignore when syncing
type: string
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
file_count:
title: File count
type: integer
readOnly: true
WritableDataSource:
required:
- name
- source_url
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
type:
title: Type
type: string
enum:
- local
- git
- amazon-s3
source_url:
title: URL
type: string
maxLength: 200
minLength: 1
enabled:
title: Enabled
type: boolean
status:
title: Status
type: string
readOnly: true
minLength: 1
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
parameters:
title: Parameters
type: object
x-nullable: true
ignore_rules:
title: Ignore rules
description: Patterns (one per line) matching files to ignore when syncing
type: string
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
file_count:
title: File count
type: integer
readOnly: true
NestedUser:
required:
- username
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
username:
title: Username
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
type: string
pattern: ^[\w.@+-]+$
maxLength: 150
minLength: 1
Job:
required:
- name
- job_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
object_type:
title: Object type
type: string
readOnly: true
object_id:
title: Object id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
name:
title: Name
type: string
maxLength: 200
minLength: 1
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Pending
- Scheduled
- Running
- Completed
- Errored
- Failed
value:
type: string
enum:
- pending
- scheduled
- running
- completed
- errored
- failed
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
scheduled:
title: Scheduled
type: string
format: date-time
x-nullable: true
interval:
title: Interval
description: Recurrence interval (in minutes)
type: integer
maximum: 2147483647
minimum: 1
x-nullable: true
started:
title: Started
type: string
format: date-time
x-nullable: true
completed:
title: Completed
type: string
format: date-time
x-nullable: true
user:
$ref: '#/definitions/NestedUser'
data:
title: Data
type: object
x-nullable: true
job_id:
title: Job id
type: string
format: uuid
CableTermination:
required:
- cable
- cable_end
- termination_type
- termination_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
cable:
title: Cable
type: integer
cable_end:
title: End
type: string
enum:
- A
- B
termination_type:
title: Termination type
type: string
termination_id:
title: Termination id
type: integer
maximum: 9223372036854775807
minimum: 0
termination:
title: Termination
type: object
readOnly: true
GenericObject:
required:
- object_type
- object_id
type: object
properties:
object_type:
title: Object type
type: string
object_id:
title: Object id
type: integer
object:
title: Object
type: object
readOnly: true
Cable:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
type:
title: Type
type: string
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
- mmf-om5
- smf
- smf-os1
- smf-os2
- aoc
- power
a_terminations:
type: array
items:
$ref: '#/definitions/GenericObject'
b_terminations:
type: array
items:
$ref: '#/definitions/GenericObject'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Connected
- Planned
- Decommissioning
value:
type: string
enum:
- connected
- planned
- decommissioning
tenant:
$ref: '#/definitions/NestedTenant'
label:
title: Label
type: string
maxLength: 100
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
length:
title: Length
type: number
format: decimal
x-nullable: true
length_unit:
title: Length unit
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Kilometers
- Meters
- Centimeters
- Miles
- Feet
- Inches
value:
type: string
enum:
- km
- m
- cm
- mi
- ft
- in
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableCable:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
type:
title: Type
type: string
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
- mmf-om5
- smf
- smf-os1
- smf-os2
- aoc
- power
a_terminations:
type: array
items:
$ref: '#/definitions/GenericObject'
b_terminations:
type: array
items:
$ref: '#/definitions/GenericObject'
status:
title: Status
type: string
enum:
- connected
- planned
- decommissioning
tenant:
title: Tenant
type: integer
x-nullable: true
label:
title: Label
type: string
maxLength: 100
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
length:
title: Length
type: number
format: decimal
x-nullable: true
length_unit:
title: Length unit
type: string
enum:
- km
- m
- cm
- mi
- ft
- in
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedManufacturer:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
devicetype_count:
title: Devicetype count
type: integer
readOnly: true
NestedDeviceType:
required:
- model
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
manufacturer:
$ref: '#/definitions/NestedManufacturer'
model:
title: Model
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
device_count:
title: Device count
type: integer
readOnly: true
NestedDeviceRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
NestedPlatform:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
x-nullable: true
NestedLocation:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
rack_count:
title: Rack count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
x-nullable: true
NestedRack:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
device_count:
title: Device count
type: integer
readOnly: true
x-nullable: true
NestedDevice:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
x-nullable: true
NestedIPAddress:
required:
- address
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
type: integer
readOnly: true
address:
title: Address
description: IPv4 or IPv6 address (with mask)
type: string
NestedCluster:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
x-nullable: true
NestedVirtualChassis:
required:
- name
- master
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
master:
$ref: '#/definitions/NestedDevice'
member_count:
title: Member count
type: integer
readOnly: true
x-nullable: true
NestedConfigTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
x-nullable: true
Device:
required:
- device_type
- device_role
- site
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
x-nullable: true
device_type:
$ref: '#/definitions/NestedDeviceType'
device_role:
$ref: '#/definitions/NestedDeviceRole'
tenant:
$ref: '#/definitions/NestedTenant'
platform:
$ref: '#/definitions/NestedPlatform'
serial:
title: Serial number
description: Chassis serial number, assigned by the manufacturer
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this device
type: string
maxLength: 50
x-nullable: true
site:
$ref: '#/definitions/NestedSite'
location:
$ref: '#/definitions/NestedLocation'
rack:
$ref: '#/definitions/NestedRack'
position:
title: Position (U)
type: number
format: decimal
minimum: 0.5
x-nullable: true
face:
title: Face
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Front
- Rear
value:
type: string
enum:
- front
- rear
parent_device:
$ref: '#/definitions/NestedDevice'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Offline
- Active
- Planned
- Staged
- Failed
- Inventory
- Decommissioning
value:
type: string
enum:
- offline
- active
- planned
- staged
- failed
- inventory
- decommissioning
airflow:
title: Airflow
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Front to rear
- Rear to front
- Left to right
- Right to left
- Side to rear
- Passive
- Mixed
value:
type: string
enum:
- front-to-rear
- rear-to-front
- left-to-right
- right-to-left
- side-to-rear
- passive
- mixed
primary_ip:
$ref: '#/definitions/NestedIPAddress'
primary_ip4:
$ref: '#/definitions/NestedIPAddress'
primary_ip6:
$ref: '#/definitions/NestedIPAddress'
cluster:
$ref: '#/definitions/NestedCluster'
virtual_chassis:
$ref: '#/definitions/NestedVirtualChassis'
vc_position:
title: Vc position
type: integer
maximum: 255
minimum: 0
x-nullable: true
vc_priority:
title: Vc priority
description: Virtual chassis master election priority
type: integer
maximum: 255
minimum: 0
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
config_template:
$ref: '#/definitions/NestedConfigTemplate'
local_context_data:
title: Local context data
description: Local config context data takes precedence over source contexts
in the final rendered config context
type: object
x-nullable: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedModuleType:
required:
- model
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
manufacturer:
$ref: '#/definitions/NestedManufacturer'
model:
title: Model
type: string
maxLength: 100
minLength: 1
x-nullable: true
ConsolePortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- DE-9
- DB-25
- RJ-11
- RJ-12
- RJ-45
- Mini-DIN 8
- USB Type A
- USB Type B
- USB Type C
- USB Mini A
- USB Mini B
- USB Micro A
- USB Micro B
- USB Micro AB
- Other
value:
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableConsolePortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ModuleNestedModuleBay:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
ComponentNestedModule:
required:
- device
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module_bay:
$ref: '#/definitions/ModuleNestedModuleBay'
x-nullable: true
ConsolePort:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- DE-9
- DB-25
- RJ-11
- RJ-12
- RJ-45
- Mini-DIN 8
- USB Type A
- USB Type B
- USB Type C
- USB Mini A
- USB Mini B
- USB Micro A
- USB Micro B
- USB Micro AB
- Other
value:
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
speed:
title: Speed
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 1200 bps
- 2400 bps
- 4800 bps
- 9600 bps
- 19.2 kbps
- 38.4 kbps
- 57.6 kbps
- 115.2 kbps
value:
type: integer
enum:
- 1200
- 2400
- 4800
- 9600
- 19200
- 38400
- 57600
- 115200
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritableConsolePort:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
description: Physical port type
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
speed:
title: Speed
description: Port speed in bits per second
type: integer
enum:
- 1200
- 2400
- 4800
- 9600
- 19200
- 38400
- 57600
- 115200
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
ConsoleServerPortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- DE-9
- DB-25
- RJ-11
- RJ-12
- RJ-45
- Mini-DIN 8
- USB Type A
- USB Type B
- USB Type C
- USB Mini A
- USB Mini B
- USB Micro A
- USB Micro B
- USB Micro AB
- Other
value:
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableConsoleServerPortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ConsoleServerPort:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- DE-9
- DB-25
- RJ-11
- RJ-12
- RJ-45
- Mini-DIN 8
- USB Type A
- USB Type B
- USB Type C
- USB Mini A
- USB Mini B
- USB Micro A
- USB Micro B
- USB Micro AB
- Other
value:
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
speed:
title: Speed
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 1200 bps
- 2400 bps
- 4800 bps
- 9600 bps
- 19.2 kbps
- 38.4 kbps
- 57.6 kbps
- 115.2 kbps
value:
type: integer
enum:
- 1200
- 2400
- 4800
- 9600
- 19200
- 38400
- 57600
- 115200
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritableConsoleServerPort:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
description: Physical port type
type: string
enum:
- de-9
- db-25
- rj-11
- rj-12
- rj-45
- mini-din-8
- usb-a
- usb-b
- usb-c
- usb-mini-a
- usb-mini-b
- usb-micro-a
- usb-micro-b
- usb-micro-ab
- other
speed:
title: Speed
description: Port speed in bits per second
type: integer
enum:
- 1200
- 2400
- 4800
- 9600
- 19200
- 38400
- 57600
- 115200
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
DeviceBayTemplate:
required:
- device_type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableDeviceBayTemplate:
required:
- device_type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
DeviceBay:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
installed_device:
$ref: '#/definitions/NestedDevice'
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableDeviceBay:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
installed_device:
title: Installed device
type: integer
x-nullable: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
DeviceRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
minLength: 1
vm_role:
title: VM Role
description: Virtual machines may be assigned to this role
type: boolean
config_template:
$ref: '#/definitions/NestedConfigTemplate'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
WritableDeviceRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
minLength: 1
vm_role:
title: VM Role
description: Virtual machines may be assigned to this role
type: boolean
config_template:
title: Config template
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
DeviceType:
required:
- manufacturer
- model
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
manufacturer:
$ref: '#/definitions/NestedManufacturer'
default_platform:
$ref: '#/definitions/NestedPlatform'
model:
title: Model
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
part_number:
title: Part number
description: Discrete part number (optional)
type: string
maxLength: 50
u_height:
title: Position (U)
type: number
format: decimal
default: 1.0
minimum: 0
is_full_depth:
title: Is full depth
description: Device consumes both front and rear rack faces
type: boolean
subdevice_role:
title: Subdevice role
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Parent
- Child
value:
type: string
enum:
- parent
- child
airflow:
title: Airflow
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Front to rear
- Rear to front
- Left to right
- Right to left
- Side to rear
- Passive
- Mixed
value:
type: string
enum:
- front-to-rear
- rear-to-front
- left-to-right
- right-to-left
- side-to-rear
- passive
- mixed
weight:
title: Weight
type: number
format: decimal
x-nullable: true
weight_unit:
title: Weight unit
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Kilograms
- Grams
- Pounds
- Ounces
value:
type: string
enum:
- kg
- g
- lb
- oz
front_image:
title: Front image
type: string
readOnly: true
format: uri
rear_image:
title: Rear image
type: string
readOnly: true
format: uri
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
WritableDeviceType:
required:
- manufacturer
- model
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
manufacturer:
title: Manufacturer
type: integer
default_platform:
title: Default platform
type: integer
x-nullable: true
model:
title: Model
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
part_number:
title: Part number
description: Discrete part number (optional)
type: string
maxLength: 50
u_height:
title: Position (U)
type: number
format: decimal
default: 1.0
minimum: 0
is_full_depth:
title: Is full depth
description: Device consumes both front and rear rack faces
type: boolean
subdevice_role:
title: Parent/child status
description: Parent devices house child devices in device bays. Leave blank
if this device type is neither a parent nor a child.
type: string
enum:
- parent
- child
airflow:
title: Airflow
type: string
enum:
- front-to-rear
- rear-to-front
- left-to-right
- right-to-left
- side-to-rear
- passive
- mixed
weight:
title: Weight
type: number
format: decimal
x-nullable: true
weight_unit:
title: Weight unit
type: string
enum:
- kg
- g
- lb
- oz
front_image:
title: Front image
type: string
readOnly: true
format: uri
rear_image:
title: Rear image
type: string
readOnly: true
format: uri
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
NestedRearPortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
FrontPortTemplate:
required:
- name
- type
- rear_port
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 8P8C
- 8P6C
- 8P4C
- 8P2C
- 6P6C
- 6P4C
- 6P2C
- 4P4C
- 4P2C
- GG45
- TERA 4P
- TERA 2P
- TERA 1P
- 110 Punch
- BNC
- F Connector
- N Connector
- MRJ21
- FC
- LC
- LC/PC
- LC/UPC
- LC/APC
- LSH
- LSH/PC
- LSH/UPC
- LSH/APC
- MPO
- MTRJ
- SC
- SC/PC
- SC/UPC
- SC/APC
- ST
- CS
- SN
- SMA 905
- SMA 906
- URM-P2
- URM-P4
- URM-P8
- Splice
- Other
value:
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
rear_port:
$ref: '#/definitions/NestedRearPortTemplate'
rear_port_position:
title: Rear port position
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableFrontPortTemplate:
required:
- name
- type
- rear_port
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
rear_port:
title: Rear port
type: integer
rear_port_position:
title: Rear port position
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
FrontPortRearPort:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
FrontPort:
required:
- device
- name
- type
- rear_port
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 8P8C
- 8P6C
- 8P4C
- 8P2C
- 6P6C
- 6P4C
- 6P2C
- 4P4C
- 4P2C
- GG45
- TERA 4P
- TERA 2P
- TERA 1P
- 110 Punch
- BNC
- F Connector
- N Connector
- MRJ21
- FC
- LC
- LC/PC
- LC/UPC
- LC/APC
- LSH
- LSH/PC
- LSH/UPC
- LSH/APC
- MPO
- MTRJ
- SC
- SC/PC
- SC/UPC
- SC/APC
- ST
- CS
- SN
- SMA 905
- SMA 906
- URM-P2
- URM-P4
- URM-P8
- Splice
- Other
value:
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
rear_port:
$ref: '#/definitions/FrontPortRearPort'
rear_port_position:
title: Rear port position
description: Mapped position on corresponding rear port
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritableFrontPort:
required:
- device
- name
- type
- rear_port
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
rear_port:
title: Rear port
type: integer
rear_port_position:
title: Rear port position
description: Mapped position on corresponding rear port
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
NestedInterfaceTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
x-nullable: true
InterfaceTemplate:
required:
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Virtual
- Bridge
- Link Aggregation Group (LAG)
- 100BASE-FX (10/100ME FIBER)
- 100BASE-LFX (10/100ME FIBER)
- 100BASE-TX (10/100ME)
- 100BASE-T1 (10/100ME Single Pair)
- 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)
- SFP56 (50GE)
- QSFP+ (40GE)
- QSFP28 (50GE)
- CFP (100GE)
- CFP2 (100GE)
- CFP2 (200GE)
- CFP4 (100GE)
- Cisco CPAK (100GE)
- QSFP28 (100GE)
- QSFP56 (200GE)
- QSFP-DD (400GE)
- OSFP (400GE)
- QSFP-DD (800GE)
- OSFP (800GE)
- 1000BASE-KX (1GE)
- 10GBASE-KR (10GE)
- 10GBASE-KX4 (10GE)
- 25GBASE-KR (25GE)
- 40GBASE-KR4 (40GE)
- 50GBASE-KR (50GE)
- 100GBASE-KP4 (100GE)
- 100GBASE-KR2 (100GE)
- 100GBASE-KR4 (100GE)
- IEEE 802.11a
- IEEE 802.11b/g
- IEEE 802.11n
- IEEE 802.11ac
- IEEE 802.11ad
- IEEE 802.11ax
- IEEE 802.11ay
- IEEE 802.15.1 (Bluetooth)
- Other (Wireless)
- 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)
- QSFP+ (64GFC)
- 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)
- xDSL
- DOCSIS
- GPON (2.5 Gbps / 1.25 Gps)
- XG-PON (10 Gbps / 2.5 Gbps)
- XGS-PON (10 Gbps)
- NG-PON2 (TWDM-PON) (4x10 Gbps)
- EPON (1 Gbps)
- 10G-EPON (10 Gbps)
- Cisco StackWise
- Cisco StackWise Plus
- Cisco FlexStack
- Cisco FlexStack Plus
- Cisco StackWise-80
- Cisco StackWise-160
- Cisco StackWise-320
- Cisco StackWise-480
- Cisco StackWise-1T
- Juniper VCP
- Extreme SummitStack
- Extreme SummitStack-128
- Extreme SummitStack-256
- Extreme SummitStack-512
- Other
value:
type: string
enum:
- virtual
- bridge
- lag
- 100base-fx
- 100base-lfx
- 100base-tx
- 100base-t1
- 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
- 50gbase-x-sfp56
- 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
- 800gbase-x-qsfpdd
- 800gbase-x-osfp
- 1000base-kx
- 10gbase-kr
- 10gbase-kx4
- 25gbase-kr
- 40gbase-kr4
- 50gbase-kr
- 100gbase-kp4
- 100gbase-kr2
- 100gbase-kr4
- ieee802.11a
- ieee802.11g
- ieee802.11n
- ieee802.11ac
- ieee802.11ad
- ieee802.11ax
- ieee802.11ay
- ieee802.15.1
- other-wireless
- 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
- 64gfc-qsfpp
- 128gfc-qsfp28
- infiniband-sdr
- infiniband-ddr
- infiniband-qdr
- infiniband-fdr10
- infiniband-fdr
- infiniband-edr
- infiniband-hdr
- infiniband-ndr
- infiniband-xdr
- t1
- e1
- t3
- e3
- xdsl
- docsis
- gpon
- xg-pon
- xgs-pon
- ng-pon2
- epon
- 10g-epon
- cisco-stackwise
- cisco-stackwise-plus
- cisco-flexstack
- cisco-flexstack-plus
- cisco-stackwise-80
- cisco-stackwise-160
- cisco-stackwise-320
- cisco-stackwise-480
- cisco-stackwise-1t
- juniper-vcp
- extreme-summitstack
- extreme-summitstack-128
- extreme-summitstack-256
- extreme-summitstack-512
- other
enabled:
title: Enabled
type: boolean
mgmt_only:
title: Management only
type: boolean
description:
title: Description
type: string
maxLength: 200
bridge:
$ref: '#/definitions/NestedInterfaceTemplate'
poe_mode:
title: Poe mode
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- PD
- PSE
value:
type: string
enum:
- pd
- pse
poe_type:
title: Poe type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 802.3af (Type 1)
- 802.3at (Type 2)
- 802.3bt (Type 3)
- 802.3bt (Type 4)
- Passive 24V (2-pair)
- Passive 24V (4-pair)
- Passive 48V (2-pair)
- Passive 48V (4-pair)
value:
type: string
enum:
- type1-ieee802.3af
- type2-ieee802.3at
- type3-ieee802.3bt
- type4-ieee802.3bt
- passive-24v-2pair
- passive-24v-4pair
- passive-48v-2pair
- passive-48v-4pair
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableInterfaceTemplate:
required:
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- virtual
- bridge
- lag
- 100base-fx
- 100base-lfx
- 100base-tx
- 100base-t1
- 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
- 50gbase-x-sfp56
- 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
- 800gbase-x-qsfpdd
- 800gbase-x-osfp
- 1000base-kx
- 10gbase-kr
- 10gbase-kx4
- 25gbase-kr
- 40gbase-kr4
- 50gbase-kr
- 100gbase-kp4
- 100gbase-kr2
- 100gbase-kr4
- ieee802.11a
- ieee802.11g
- ieee802.11n
- ieee802.11ac
- ieee802.11ad
- ieee802.11ax
- ieee802.11ay
- ieee802.15.1
- other-wireless
- 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
- 64gfc-qsfpp
- 128gfc-qsfp28
- infiniband-sdr
- infiniband-ddr
- infiniband-qdr
- infiniband-fdr10
- infiniband-fdr
- infiniband-edr
- infiniband-hdr
- infiniband-ndr
- infiniband-xdr
- t1
- e1
- t3
- e3
- xdsl
- docsis
- gpon
- xg-pon
- xgs-pon
- ng-pon2
- epon
- 10g-epon
- cisco-stackwise
- cisco-stackwise-plus
- cisco-flexstack
- cisco-flexstack-plus
- cisco-stackwise-80
- cisco-stackwise-160
- cisco-stackwise-320
- cisco-stackwise-480
- cisco-stackwise-1t
- juniper-vcp
- extreme-summitstack
- extreme-summitstack-128
- extreme-summitstack-256
- extreme-summitstack-512
- other
enabled:
title: Enabled
type: boolean
mgmt_only:
title: Management only
type: boolean
description:
title: Description
type: string
maxLength: 200
bridge:
title: Bridge interface
type: integer
x-nullable: true
poe_mode:
title: PoE mode
type: string
enum:
- pd
- pse
poe_type:
title: PoE type
type: string
enum:
- type1-ieee802.3af
- type2-ieee802.3at
- type3-ieee802.3bt
- type4-ieee802.3bt
- passive-24v-2pair
- passive-24v-4pair
- passive-48v-2pair
- passive-48v-4pair
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedVirtualDeviceContext:
required:
- name
- device
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
identifier:
title: Identifier
description: Numeric identifier unique to the parent device
type: integer
maximum: 32767
minimum: 0
x-nullable: true
device:
$ref: '#/definitions/NestedDevice'
NestedInterface:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
name:
title: Name
type: string
maxLength: 64
minLength: 1
cable:
title: Cable
type: integer
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
x-nullable: true
NestedVLAN:
required:
- vid
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
vid:
title: ID
description: Numeric VLAN ID (1-4094)
type: integer
maximum: 4094
minimum: 1
name:
title: Name
type: string
maxLength: 64
minLength: 1
x-nullable: true
NestedWirelessLink:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
ssid:
title: SSID
type: string
maxLength: 32
NestedWirelessLAN:
required:
- ssid
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
ssid:
title: SSID
type: string
maxLength: 32
minLength: 1
NestedVRF:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
rd:
title: Route distinguisher
description: Unique route distinguisher (as defined in RFC 4364)
type: string
maxLength: 21
x-nullable: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
x-nullable: true
NestedL2VPN:
required:
- name
- slug
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
identifier:
title: Identifier
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
type:
title: Type
type: string
enum:
- vpws
- vpls
- vxlan
- vxlan-evpn
- mpls-evpn
- pbb-evpn
- epl
- evpl
- ep-lan
- evp-lan
- ep-tree
- evp-tree
NestedL2VPNTermination:
required:
- l2vpn
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
l2vpn:
$ref: '#/definitions/NestedL2VPN'
Interface:
required:
- device
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
vdcs:
type: array
items:
$ref: '#/definitions/NestedVirtualDeviceContext'
uniqueItems: true
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Virtual
- Bridge
- Link Aggregation Group (LAG)
- 100BASE-FX (10/100ME FIBER)
- 100BASE-LFX (10/100ME FIBER)
- 100BASE-TX (10/100ME)
- 100BASE-T1 (10/100ME Single Pair)
- 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)
- SFP56 (50GE)
- QSFP+ (40GE)
- QSFP28 (50GE)
- CFP (100GE)
- CFP2 (100GE)
- CFP2 (200GE)
- CFP4 (100GE)
- Cisco CPAK (100GE)
- QSFP28 (100GE)
- QSFP56 (200GE)
- QSFP-DD (400GE)
- OSFP (400GE)
- QSFP-DD (800GE)
- OSFP (800GE)
- 1000BASE-KX (1GE)
- 10GBASE-KR (10GE)
- 10GBASE-KX4 (10GE)
- 25GBASE-KR (25GE)
- 40GBASE-KR4 (40GE)
- 50GBASE-KR (50GE)
- 100GBASE-KP4 (100GE)
- 100GBASE-KR2 (100GE)
- 100GBASE-KR4 (100GE)
- IEEE 802.11a
- IEEE 802.11b/g
- IEEE 802.11n
- IEEE 802.11ac
- IEEE 802.11ad
- IEEE 802.11ax
- IEEE 802.11ay
- IEEE 802.15.1 (Bluetooth)
- Other (Wireless)
- 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)
- QSFP+ (64GFC)
- 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)
- xDSL
- DOCSIS
- GPON (2.5 Gbps / 1.25 Gps)
- XG-PON (10 Gbps / 2.5 Gbps)
- XGS-PON (10 Gbps)
- NG-PON2 (TWDM-PON) (4x10 Gbps)
- EPON (1 Gbps)
- 10G-EPON (10 Gbps)
- Cisco StackWise
- Cisco StackWise Plus
- Cisco FlexStack
- Cisco FlexStack Plus
- Cisco StackWise-80
- Cisco StackWise-160
- Cisco StackWise-320
- Cisco StackWise-480
- Cisco StackWise-1T
- Juniper VCP
- Extreme SummitStack
- Extreme SummitStack-128
- Extreme SummitStack-256
- Extreme SummitStack-512
- Other
value:
type: string
enum:
- virtual
- bridge
- lag
- 100base-fx
- 100base-lfx
- 100base-tx
- 100base-t1
- 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
- 50gbase-x-sfp56
- 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
- 800gbase-x-qsfpdd
- 800gbase-x-osfp
- 1000base-kx
- 10gbase-kr
- 10gbase-kx4
- 25gbase-kr
- 40gbase-kr4
- 50gbase-kr
- 100gbase-kp4
- 100gbase-kr2
- 100gbase-kr4
- ieee802.11a
- ieee802.11g
- ieee802.11n
- ieee802.11ac
- ieee802.11ad
- ieee802.11ax
- ieee802.11ay
- ieee802.15.1
- other-wireless
- 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
- 64gfc-qsfpp
- 128gfc-qsfp28
- infiniband-sdr
- infiniband-ddr
- infiniband-qdr
- infiniband-fdr10
- infiniband-fdr
- infiniband-edr
- infiniband-hdr
- infiniband-ndr
- infiniband-xdr
- t1
- e1
- t3
- e3
- xdsl
- docsis
- gpon
- xg-pon
- xgs-pon
- ng-pon2
- epon
- 10g-epon
- cisco-stackwise
- cisco-stackwise-plus
- cisco-flexstack
- cisco-flexstack-plus
- cisco-stackwise-80
- cisco-stackwise-160
- cisco-stackwise-320
- cisco-stackwise-480
- cisco-stackwise-1t
- juniper-vcp
- extreme-summitstack
- extreme-summitstack-128
- extreme-summitstack-256
- extreme-summitstack-512
- other
enabled:
title: Enabled
type: boolean
parent:
$ref: '#/definitions/NestedInterface'
bridge:
$ref: '#/definitions/NestedInterface'
lag:
$ref: '#/definitions/NestedInterface'
mtu:
title: MTU
type: integer
maximum: 65536
minimum: 1
x-nullable: true
mac_address:
title: MAC Address
type: string
x-nullable: true
speed:
title: Speed (Kbps)
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
duplex:
title: Duplex
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Half
- Full
- Auto
value:
type: string
enum:
- half
- full
- auto
wwn:
title: WWN
description: 64-bit World Wide Name
type: string
x-nullable: true
mgmt_only:
title: Management only
description: This interface is used only for out-of-band management
type: boolean
description:
title: Description
type: string
maxLength: 200
mode:
title: Mode
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Access
- Tagged
- Tagged (All)
value:
type: string
enum:
- access
- tagged
- tagged-all
rf_role:
title: Rf role
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Access point
- Station
value:
type: string
enum:
- ap
- station
rf_channel:
title: Rf channel
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 1 (2412 MHz)
- 2 (2417 MHz)
- 3 (2422 MHz)
- 4 (2427 MHz)
- 5 (2432 MHz)
- 6 (2437 MHz)
- 7 (2442 MHz)
- 8 (2447 MHz)
- 9 (2452 MHz)
- 10 (2457 MHz)
- 11 (2462 MHz)
- 12 (2467 MHz)
- 13 (2472 MHz)
- 32 (5160/20 MHz)
- 34 (5170/40 MHz)
- 36 (5180/20 MHz)
- 38 (5190/40 MHz)
- 40 (5200/20 MHz)
- 42 (5210/80 MHz)
- 44 (5220/20 MHz)
- 46 (5230/40 MHz)
- 48 (5240/20 MHz)
- 50 (5250/160 MHz)
- 52 (5260/20 MHz)
- 54 (5270/40 MHz)
- 56 (5280/20 MHz)
- 58 (5290/80 MHz)
- 60 (5300/20 MHz)
- 62 (5310/40 MHz)
- 64 (5320/20 MHz)
- 100 (5500/20 MHz)
- 102 (5510/40 MHz)
- 104 (5520/20 MHz)
- 106 (5530/80 MHz)
- 108 (5540/20 MHz)
- 110 (5550/40 MHz)
- 112 (5560/20 MHz)
- 114 (5570/160 MHz)
- 116 (5580/20 MHz)
- 118 (5590/40 MHz)
- 120 (5600/20 MHz)
- 122 (5610/80 MHz)
- 124 (5620/20 MHz)
- 126 (5630/40 MHz)
- 128 (5640/20 MHz)
- 132 (5660/20 MHz)
- 134 (5670/40 MHz)
- 136 (5680/20 MHz)
- 138 (5690/80 MHz)
- 140 (5700/20 MHz)
- 142 (5710/40 MHz)
- 144 (5720/20 MHz)
- 149 (5745/20 MHz)
- 151 (5755/40 MHz)
- 153 (5765/20 MHz)
- 155 (5775/80 MHz)
- 157 (5785/20 MHz)
- 159 (5795/40 MHz)
- 161 (5805/20 MHz)
- 163 (5815/160 MHz)
- 165 (5825/20 MHz)
- 167 (5835/40 MHz)
- 169 (5845/20 MHz)
- 171 (5855/80 MHz)
- 173 (5865/20 MHz)
- 175 (5875/40 MHz)
- 177 (5885/20 MHz)
- 1 (5955/20 MHz)
- 3 (5965/40 MHz)
- 5 (5975/20 MHz)
- 7 (5985/80 MHz)
- 9 (5995/20 MHz)
- 11 (6005/40 MHz)
- 13 (6015/20 MHz)
- 15 (6025/160 MHz)
- 17 (6035/20 MHz)
- 19 (6045/40 MHz)
- 21 (6055/20 MHz)
- 23 (6065/80 MHz)
- 25 (6075/20 MHz)
- 27 (6085/40 MHz)
- 29 (6095/20 MHz)
- 31 (6105/320 MHz)
- 33 (6115/20 MHz)
- 35 (6125/40 MHz)
- 37 (6135/20 MHz)
- 39 (6145/80 MHz)
- 41 (6155/20 MHz)
- 43 (6165/40 MHz)
- 45 (6175/20 MHz)
- 47 (6185/160 MHz)
- 49 (6195/20 MHz)
- 51 (6205/40 MHz)
- 53 (6215/20 MHz)
- 55 (6225/80 MHz)
- 57 (6235/20 MHz)
- 59 (6245/40 MHz)
- 61 (6255/20 MHz)
- 65 (6275/20 MHz)
- 67 (6285/40 MHz)
- 69 (6295/20 MHz)
- 71 (6305/80 MHz)
- 73 (6315/20 MHz)
- 75 (6325/40 MHz)
- 77 (6335/20 MHz)
- 79 (6345/160 MHz)
- 81 (6355/20 MHz)
- 83 (6365/40 MHz)
- 85 (6375/20 MHz)
- 87 (6385/80 MHz)
- 89 (6395/20 MHz)
- 91 (6405/40 MHz)
- 93 (6415/20 MHz)
- 95 (6425/320 MHz)
- 97 (6435/20 MHz)
- 99 (6445/40 MHz)
- 101 (6455/20 MHz)
- 103 (6465/80 MHz)
- 105 (6475/20 MHz)
- 107 (6485/40 MHz)
- 109 (6495/20 MHz)
- 111 (6505/160 MHz)
- 113 (6515/20 MHz)
- 115 (6525/40 MHz)
- 117 (6535/20 MHz)
- 119 (6545/80 MHz)
- 121 (6555/20 MHz)
- 123 (6565/40 MHz)
- 125 (6575/20 MHz)
- 129 (6595/20 MHz)
- 131 (6605/40 MHz)
- 133 (6615/20 MHz)
- 135 (6625/80 MHz)
- 137 (6635/20 MHz)
- 139 (6645/40 MHz)
- 141 (6655/20 MHz)
- 143 (6665/160 MHz)
- 145 (6675/20 MHz)
- 147 (6685/40 MHz)
- 149 (6695/20 MHz)
- 151 (6705/80 MHz)
- 153 (6715/20 MHz)
- 155 (6725/40 MHz)
- 157 (6735/20 MHz)
- 159 (6745/320 MHz)
- 161 (6755/20 MHz)
- 163 (6765/40 MHz)
- 165 (6775/20 MHz)
- 167 (6785/80 MHz)
- 169 (6795/20 MHz)
- 171 (6805/40 MHz)
- 173 (6815/20 MHz)
- 175 (6825/160 MHz)
- 177 (6835/20 MHz)
- 179 (6845/40 MHz)
- 181 (6855/20 MHz)
- 183 (6865/80 MHz)
- 185 (6875/20 MHz)
- 187 (6885/40 MHz)
- 189 (6895/20 MHz)
- 193 (6915/20 MHz)
- 195 (6925/40 MHz)
- 197 (6935/20 MHz)
- 199 (6945/80 MHz)
- 201 (6955/20 MHz)
- 203 (6965/40 MHz)
- 205 (6975/20 MHz)
- 207 (6985/160 MHz)
- 209 (6995/20 MHz)
- 211 (7005/40 MHz)
- 213 (7015/20 MHz)
- 215 (7025/80 MHz)
- 217 (7035/20 MHz)
- 219 (7045/40 MHz)
- 221 (7055/20 MHz)
- 225 (7075/20 MHz)
- 227 (7085/40 MHz)
- 229 (7095/20 MHz)
- 233 (7115/20 MHz)
- 1 (58.32/2.16 GHz)
- 2 (60.48/2.16 GHz)
- 3 (62.64/2.16 GHz)
- 4 (64.80/2.16 GHz)
- 5 (66.96/2.16 GHz)
- 6 (69.12/2.16 GHz)
- 9 (59.40/4.32 GHz)
- 10 (61.56/4.32 GHz)
- 11 (63.72/4.32 GHz)
- 12 (65.88/4.32 GHz)
- 13 (68.04/4.32 GHz)
- 17 (60.48/6.48 GHz)
- 18 (62.64/6.48 GHz)
- 19 (64.80/6.48 GHz)
- 20 (66.96/6.48 GHz)
- 25 (61.56/8.64 GHz)
- 26 (63.72/8.64 GHz)
- 27 (65.88/8.64 GHz)
value:
type: string
enum:
- 2.4g-1-2412-22
- 2.4g-2-2417-22
- 2.4g-3-2422-22
- 2.4g-4-2427-22
- 2.4g-5-2432-22
- 2.4g-6-2437-22
- 2.4g-7-2442-22
- 2.4g-8-2447-22
- 2.4g-9-2452-22
- 2.4g-10-2457-22
- 2.4g-11-2462-22
- 2.4g-12-2467-22
- 2.4g-13-2472-22
- 5g-32-5160-20
- 5g-34-5170-40
- 5g-36-5180-20
- 5g-38-5190-40
- 5g-40-5200-20
- 5g-42-5210-80
- 5g-44-5220-20
- 5g-46-5230-40
- 5g-48-5240-20
- 5g-50-5250-160
- 5g-52-5260-20
- 5g-54-5270-40
- 5g-56-5280-20
- 5g-58-5290-80
- 5g-60-5300-20
- 5g-62-5310-40
- 5g-64-5320-20
- 5g-100-5500-20
- 5g-102-5510-40
- 5g-104-5520-20
- 5g-106-5530-80
- 5g-108-5540-20
- 5g-110-5550-40
- 5g-112-5560-20
- 5g-114-5570-160
- 5g-116-5580-20
- 5g-118-5590-40
- 5g-120-5600-20
- 5g-122-5610-80
- 5g-124-5620-20
- 5g-126-5630-40
- 5g-128-5640-20
- 5g-132-5660-20
- 5g-134-5670-40
- 5g-136-5680-20
- 5g-138-5690-80
- 5g-140-5700-20
- 5g-142-5710-40
- 5g-144-5720-20
- 5g-149-5745-20
- 5g-151-5755-40
- 5g-153-5765-20
- 5g-155-5775-80
- 5g-157-5785-20
- 5g-159-5795-40
- 5g-161-5805-20
- 5g-163-5815-160
- 5g-165-5825-20
- 5g-167-5835-40
- 5g-169-5845-20
- 5g-171-5855-80
- 5g-173-5865-20
- 5g-175-5875-40
- 5g-177-5885-20
- 6g-1-5955-20
- 6g-3-5965-40
- 6g-5-5975-20
- 6g-7-5985-80
- 6g-9-5995-20
- 6g-11-6005-40
- 6g-13-6015-20
- 6g-15-6025-160
- 6g-17-6035-20
- 6g-19-6045-40
- 6g-21-6055-20
- 6g-23-6065-80
- 6g-25-6075-20
- 6g-27-6085-40
- 6g-29-6095-20
- 6g-31-6105-320
- 6g-33-6115-20
- 6g-35-6125-40
- 6g-37-6135-20
- 6g-39-6145-80
- 6g-41-6155-20
- 6g-43-6165-40
- 6g-45-6175-20
- 6g-47-6185-160
- 6g-49-6195-20
- 6g-51-6205-40
- 6g-53-6215-20
- 6g-55-6225-80
- 6g-57-6235-20
- 6g-59-6245-40
- 6g-61-6255-20
- 6g-65-6275-20
- 6g-67-6285-40
- 6g-69-6295-20
- 6g-71-6305-80
- 6g-73-6315-20
- 6g-75-6325-40
- 6g-77-6335-20
- 6g-79-6345-160
- 6g-81-6355-20
- 6g-83-6365-40
- 6g-85-6375-20
- 6g-87-6385-80
- 6g-89-6395-20
- 6g-91-6405-40
- 6g-93-6415-20
- 6g-95-6425-320
- 6g-97-6435-20
- 6g-99-6445-40
- 6g-101-6455-20
- 6g-103-6465-80
- 6g-105-6475-20
- 6g-107-6485-40
- 6g-109-6495-20
- 6g-111-6505-160
- 6g-113-6515-20
- 6g-115-6525-40
- 6g-117-6535-20
- 6g-119-6545-80
- 6g-121-6555-20
- 6g-123-6565-40
- 6g-125-6575-20
- 6g-129-6595-20
- 6g-131-6605-40
- 6g-133-6615-20
- 6g-135-6625-80
- 6g-137-6635-20
- 6g-139-6645-40
- 6g-141-6655-20
- 6g-143-6665-160
- 6g-145-6675-20
- 6g-147-6685-40
- 6g-149-6695-20
- 6g-151-6705-80
- 6g-153-6715-20
- 6g-155-6725-40
- 6g-157-6735-20
- 6g-159-6745-320
- 6g-161-6755-20
- 6g-163-6765-40
- 6g-165-6775-20
- 6g-167-6785-80
- 6g-169-6795-20
- 6g-171-6805-40
- 6g-173-6815-20
- 6g-175-6825-160
- 6g-177-6835-20
- 6g-179-6845-40
- 6g-181-6855-20
- 6g-183-6865-80
- 6g-185-6875-20
- 6g-187-6885-40
- 6g-189-6895-20
- 6g-193-6915-20
- 6g-195-6925-40
- 6g-197-6935-20
- 6g-199-6945-80
- 6g-201-6955-20
- 6g-203-6965-40
- 6g-205-6975-20
- 6g-207-6985-160
- 6g-209-6995-20
- 6g-211-7005-40
- 6g-213-7015-20
- 6g-215-7025-80
- 6g-217-7035-20
- 6g-219-7045-40
- 6g-221-7055-20
- 6g-225-7075-20
- 6g-227-7085-40
- 6g-229-7095-20
- 6g-233-7115-20
- 60g-1-58320-2160
- 60g-2-60480-2160
- 60g-3-62640-2160
- 60g-4-64800-2160
- 60g-5-66960-2160
- 60g-6-69120-2160
- 60g-9-59400-4320
- 60g-10-61560-4320
- 60g-11-63720-4320
- 60g-12-65880-4320
- 60g-13-68040-4320
- 60g-17-60480-6480
- 60g-18-62640-6480
- 60g-19-64800-6480
- 60g-20-66960-6480
- 60g-25-61560-6480
- 60g-26-63720-6480
- 60g-27-65880-6480
poe_mode:
title: Poe mode
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- PD
- PSE
value:
type: string
enum:
- pd
- pse
poe_type:
title: Poe type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 802.3af (Type 1)
- 802.3at (Type 2)
- 802.3bt (Type 3)
- 802.3bt (Type 4)
- Passive 24V (2-pair)
- Passive 24V (4-pair)
- Passive 48V (2-pair)
- Passive 48V (4-pair)
value:
type: string
enum:
- type1-ieee802.3af
- type2-ieee802.3at
- type3-ieee802.3bt
- type4-ieee802.3bt
- passive-24v-2pair
- passive-24v-4pair
- passive-48v-2pair
- passive-48v-4pair
rf_channel_frequency:
title: Channel frequency (MHz)
description: Populated by selected channel (if set)
type: number
format: decimal
x-nullable: true
rf_channel_width:
title: Channel width (MHz)
description: Populated by selected channel (if set)
type: number
format: decimal
x-nullable: true
tx_power:
title: Transmit power (dBm)
type: integer
maximum: 127
minimum: 0
x-nullable: true
untagged_vlan:
$ref: '#/definitions/NestedVLAN'
tagged_vlans:
type: array
items:
$ref: '#/definitions/NestedVLAN'
uniqueItems: true
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
wireless_link:
$ref: '#/definitions/NestedWirelessLink'
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
wireless_lans:
type: array
items:
$ref: '#/definitions/NestedWirelessLAN'
uniqueItems: true
vrf:
$ref: '#/definitions/NestedVRF'
l2vpn_termination:
$ref: '#/definitions/NestedL2VPNTermination'
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
count_ipaddresses:
title: Count ipaddresses
type: integer
readOnly: true
count_fhrp_groups:
title: Count fhrp groups
type: integer
readOnly: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritableInterface:
required:
- device
- vdcs
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
vdcs:
type: array
items:
type: integer
uniqueItems: true
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- virtual
- bridge
- lag
- 100base-fx
- 100base-lfx
- 100base-tx
- 100base-t1
- 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
- 50gbase-x-sfp56
- 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
- 800gbase-x-qsfpdd
- 800gbase-x-osfp
- 1000base-kx
- 10gbase-kr
- 10gbase-kx4
- 25gbase-kr
- 40gbase-kr4
- 50gbase-kr
- 100gbase-kp4
- 100gbase-kr2
- 100gbase-kr4
- ieee802.11a
- ieee802.11g
- ieee802.11n
- ieee802.11ac
- ieee802.11ad
- ieee802.11ax
- ieee802.11ay
- ieee802.15.1
- other-wireless
- 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
- 64gfc-qsfpp
- 128gfc-qsfp28
- infiniband-sdr
- infiniband-ddr
- infiniband-qdr
- infiniband-fdr10
- infiniband-fdr
- infiniband-edr
- infiniband-hdr
- infiniband-ndr
- infiniband-xdr
- t1
- e1
- t3
- e3
- xdsl
- docsis
- gpon
- xg-pon
- xgs-pon
- ng-pon2
- epon
- 10g-epon
- cisco-stackwise
- cisco-stackwise-plus
- cisco-flexstack
- cisco-flexstack-plus
- cisco-stackwise-80
- cisco-stackwise-160
- cisco-stackwise-320
- cisco-stackwise-480
- cisco-stackwise-1t
- juniper-vcp
- extreme-summitstack
- extreme-summitstack-128
- extreme-summitstack-256
- extreme-summitstack-512
- other
enabled:
title: Enabled
type: boolean
parent:
title: Parent interface
type: integer
x-nullable: true
bridge:
title: Bridge interface
type: integer
x-nullable: true
lag:
title: Parent LAG
type: integer
x-nullable: true
mtu:
title: MTU
type: integer
maximum: 65536
minimum: 1
x-nullable: true
mac_address:
title: MAC Address
type: string
x-nullable: true
speed:
title: Speed (Kbps)
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
duplex:
title: Duplex
type: string
enum:
- half
- full
- auto
x-nullable: true
wwn:
title: WWN
description: 64-bit World Wide Name
type: string
x-nullable: true
mgmt_only:
title: Management only
description: This interface is used only for out-of-band management
type: boolean
description:
title: Description
type: string
maxLength: 200
mode:
title: Mode
description: IEEE 802.1Q tagging strategy
type: string
enum:
- access
- tagged
- tagged-all
rf_role:
title: Wireless role
type: string
enum:
- ap
- station
rf_channel:
title: Wireless channel
type: string
enum:
- 2.4g-1-2412-22
- 2.4g-2-2417-22
- 2.4g-3-2422-22
- 2.4g-4-2427-22
- 2.4g-5-2432-22
- 2.4g-6-2437-22
- 2.4g-7-2442-22
- 2.4g-8-2447-22
- 2.4g-9-2452-22
- 2.4g-10-2457-22
- 2.4g-11-2462-22
- 2.4g-12-2467-22
- 2.4g-13-2472-22
- 5g-32-5160-20
- 5g-34-5170-40
- 5g-36-5180-20
- 5g-38-5190-40
- 5g-40-5200-20
- 5g-42-5210-80
- 5g-44-5220-20
- 5g-46-5230-40
- 5g-48-5240-20
- 5g-50-5250-160
- 5g-52-5260-20
- 5g-54-5270-40
- 5g-56-5280-20
- 5g-58-5290-80
- 5g-60-5300-20
- 5g-62-5310-40
- 5g-64-5320-20
- 5g-100-5500-20
- 5g-102-5510-40
- 5g-104-5520-20
- 5g-106-5530-80
- 5g-108-5540-20
- 5g-110-5550-40
- 5g-112-5560-20
- 5g-114-5570-160
- 5g-116-5580-20
- 5g-118-5590-40
- 5g-120-5600-20
- 5g-122-5610-80
- 5g-124-5620-20
- 5g-126-5630-40
- 5g-128-5640-20
- 5g-132-5660-20
- 5g-134-5670-40
- 5g-136-5680-20
- 5g-138-5690-80
- 5g-140-5700-20
- 5g-142-5710-40
- 5g-144-5720-20
- 5g-149-5745-20
- 5g-151-5755-40
- 5g-153-5765-20
- 5g-155-5775-80
- 5g-157-5785-20
- 5g-159-5795-40
- 5g-161-5805-20
- 5g-163-5815-160
- 5g-165-5825-20
- 5g-167-5835-40
- 5g-169-5845-20
- 5g-171-5855-80
- 5g-173-5865-20
- 5g-175-5875-40
- 5g-177-5885-20
- 6g-1-5955-20
- 6g-3-5965-40
- 6g-5-5975-20
- 6g-7-5985-80
- 6g-9-5995-20
- 6g-11-6005-40
- 6g-13-6015-20
- 6g-15-6025-160
- 6g-17-6035-20
- 6g-19-6045-40
- 6g-21-6055-20
- 6g-23-6065-80
- 6g-25-6075-20
- 6g-27-6085-40
- 6g-29-6095-20
- 6g-31-6105-320
- 6g-33-6115-20
- 6g-35-6125-40
- 6g-37-6135-20
- 6g-39-6145-80
- 6g-41-6155-20
- 6g-43-6165-40
- 6g-45-6175-20
- 6g-47-6185-160
- 6g-49-6195-20
- 6g-51-6205-40
- 6g-53-6215-20
- 6g-55-6225-80
- 6g-57-6235-20
- 6g-59-6245-40
- 6g-61-6255-20
- 6g-65-6275-20
- 6g-67-6285-40
- 6g-69-6295-20
- 6g-71-6305-80
- 6g-73-6315-20
- 6g-75-6325-40
- 6g-77-6335-20
- 6g-79-6345-160
- 6g-81-6355-20
- 6g-83-6365-40
- 6g-85-6375-20
- 6g-87-6385-80
- 6g-89-6395-20
- 6g-91-6405-40
- 6g-93-6415-20
- 6g-95-6425-320
- 6g-97-6435-20
- 6g-99-6445-40
- 6g-101-6455-20
- 6g-103-6465-80
- 6g-105-6475-20
- 6g-107-6485-40
- 6g-109-6495-20
- 6g-111-6505-160
- 6g-113-6515-20
- 6g-115-6525-40
- 6g-117-6535-20
- 6g-119-6545-80
- 6g-121-6555-20
- 6g-123-6565-40
- 6g-125-6575-20
- 6g-129-6595-20
- 6g-131-6605-40
- 6g-133-6615-20
- 6g-135-6625-80
- 6g-137-6635-20
- 6g-139-6645-40
- 6g-141-6655-20
- 6g-143-6665-160
- 6g-145-6675-20
- 6g-147-6685-40
- 6g-149-6695-20
- 6g-151-6705-80
- 6g-153-6715-20
- 6g-155-6725-40
- 6g-157-6735-20
- 6g-159-6745-320
- 6g-161-6755-20
- 6g-163-6765-40
- 6g-165-6775-20
- 6g-167-6785-80
- 6g-169-6795-20
- 6g-171-6805-40
- 6g-173-6815-20
- 6g-175-6825-160
- 6g-177-6835-20
- 6g-179-6845-40
- 6g-181-6855-20
- 6g-183-6865-80
- 6g-185-6875-20
- 6g-187-6885-40
- 6g-189-6895-20
- 6g-193-6915-20
- 6g-195-6925-40
- 6g-197-6935-20
- 6g-199-6945-80
- 6g-201-6955-20
- 6g-203-6965-40
- 6g-205-6975-20
- 6g-207-6985-160
- 6g-209-6995-20
- 6g-211-7005-40
- 6g-213-7015-20
- 6g-215-7025-80
- 6g-217-7035-20
- 6g-219-7045-40
- 6g-221-7055-20
- 6g-225-7075-20
- 6g-227-7085-40
- 6g-229-7095-20
- 6g-233-7115-20
- 60g-1-58320-2160
- 60g-2-60480-2160
- 60g-3-62640-2160
- 60g-4-64800-2160
- 60g-5-66960-2160
- 60g-6-69120-2160
- 60g-9-59400-4320
- 60g-10-61560-4320
- 60g-11-63720-4320
- 60g-12-65880-4320
- 60g-13-68040-4320
- 60g-17-60480-6480
- 60g-18-62640-6480
- 60g-19-64800-6480
- 60g-20-66960-6480
- 60g-25-61560-6480
- 60g-26-63720-6480
- 60g-27-65880-6480
poe_mode:
title: PoE mode
type: string
enum:
- pd
- pse
poe_type:
title: PoE type
type: string
enum:
- type1-ieee802.3af
- type2-ieee802.3at
- type3-ieee802.3bt
- type4-ieee802.3bt
- passive-24v-2pair
- passive-24v-4pair
- passive-48v-2pair
- passive-48v-4pair
rf_channel_frequency:
title: Channel frequency (MHz)
description: Populated by selected channel (if set)
type: number
format: decimal
x-nullable: true
rf_channel_width:
title: Channel width (MHz)
description: Populated by selected channel (if set)
type: number
format: decimal
x-nullable: true
tx_power:
title: Transmit power (dBm)
type: integer
maximum: 127
minimum: 0
x-nullable: true
untagged_vlan:
title: Untagged VLAN
type: integer
x-nullable: true
tagged_vlans:
type: array
items:
title: Tagged VLANs
type: integer
uniqueItems: true
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
wireless_link:
title: Wireless link
type: integer
x-nullable: true
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
wireless_lans:
type: array
items:
title: Wireless LANs
type: integer
uniqueItems: true
vrf:
title: VRF
type: integer
x-nullable: true
l2vpn_termination:
title: L2vpn termination
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
count_ipaddresses:
title: Count ipaddresses
type: integer
readOnly: true
count_fhrp_groups:
title: Count fhrp groups
type: integer
readOnly: true
_occupied:
title: occupied
type: boolean
readOnly: true
InventoryItemRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
inventoryitem_count:
title: Inventoryitem count
type: integer
readOnly: true
NestedInventoryItemRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
inventoryitem_count:
title: Inventoryitem count
type: integer
readOnly: true
x-nullable: true
InventoryItemTemplate:
required:
- device_type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
parent:
title: Parent
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
role:
$ref: '#/definitions/NestedInventoryItemRole'
manufacturer:
$ref: '#/definitions/NestedManufacturer'
part_id:
title: Part ID
description: Manufacturer-assigned part identifier
type: string
maxLength: 50
description:
title: Description
type: string
maxLength: 200
component_type:
title: Component type
type: string
x-nullable: true
component_id:
title: Component id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
component:
title: Component
type: object
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_depth:
title: depth
type: integer
readOnly: true
WritableInventoryItemTemplate:
required:
- device_type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
parent:
title: Parent
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
role:
title: Role
type: integer
x-nullable: true
manufacturer:
title: Manufacturer
type: integer
x-nullable: true
part_id:
title: Part ID
description: Manufacturer-assigned part identifier
type: string
maxLength: 50
description:
title: Description
type: string
maxLength: 200
component_type:
title: Component type
type: string
x-nullable: true
component_id:
title: Component id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
component:
title: Component
type: object
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_depth:
title: depth
type: integer
readOnly: true
InventoryItem:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
parent:
title: Parent
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
role:
$ref: '#/definitions/NestedInventoryItemRole'
manufacturer:
$ref: '#/definitions/NestedManufacturer'
part_id:
title: Part ID
description: Manufacturer-assigned part identifier
type: string
maxLength: 50
serial:
title: Serial number
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this item
type: string
maxLength: 50
x-nullable: true
discovered:
title: Discovered
description: This item was automatically discovered
type: boolean
description:
title: Description
type: string
maxLength: 200
component_type:
title: Component type
type: string
x-nullable: true
component_id:
title: Component id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
component:
title: Component
type: object
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_depth:
title: depth
type: integer
readOnly: true
WritableInventoryItem:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
parent:
title: Parent
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
role:
title: Role
type: integer
x-nullable: true
manufacturer:
title: Manufacturer
type: integer
x-nullable: true
part_id:
title: Part ID
description: Manufacturer-assigned part identifier
type: string
maxLength: 50
serial:
title: Serial number
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this item
type: string
maxLength: 50
x-nullable: true
discovered:
title: Discovered
description: This item was automatically discovered
type: boolean
description:
title: Description
type: string
maxLength: 200
component_type:
title: Component type
type: string
x-nullable: true
component_id:
title: Component id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
component:
title: Component
type: object
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_depth:
title: depth
type: integer
readOnly: true
Location:
required:
- name
- slug
- site
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
site:
$ref: '#/definitions/NestedSite'
parent:
$ref: '#/definitions/NestedLocation'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Planned
- Staging
- Active
- Decommissioning
- Retired
value:
type: string
enum:
- planned
- staging
- active
- decommissioning
- retired
tenant:
$ref: '#/definitions/NestedTenant'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
rack_count:
title: Rack count
type: integer
readOnly: true
device_count:
title: Device count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritableLocation:
required:
- name
- slug
- site
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
site:
title: Site
type: integer
parent:
title: Parent
type: integer
x-nullable: true
status:
title: Status
type: string
enum:
- planned
- staging
- active
- decommissioning
- retired
tenant:
title: Tenant
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
rack_count:
title: Rack count
type: integer
readOnly: true
device_count:
title: Device count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
Manufacturer:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
devicetype_count:
title: Devicetype count
type: integer
readOnly: true
inventoryitem_count:
title: Inventoryitem count
type: integer
readOnly: true
platform_count:
title: Platform count
type: integer
readOnly: true
ModuleBayTemplate:
required:
- device_type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
position:
title: Position
description: Identifier to reference when renaming installed components
type: string
maxLength: 30
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableModuleBayTemplate:
required:
- device_type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
position:
title: Position
description: Identifier to reference when renaming installed components
type: string
maxLength: 30
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ModuleBayNestedModule:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
serial:
title: Serial number
type: string
maxLength: 50
x-nullable: true
ModuleBay:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
name:
title: Name
type: string
maxLength: 64
minLength: 1
installed_module:
$ref: '#/definitions/ModuleBayNestedModule'
label:
title: Label
description: Physical label
type: string
maxLength: 64
position:
title: Position
description: Identifier to reference when renaming installed components
type: string
maxLength: 30
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableModuleBay:
required:
- device
- name
- installed_module
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
name:
title: Name
type: string
maxLength: 64
minLength: 1
installed_module:
title: Installed module
type: integer
label:
title: Label
description: Physical label
type: string
maxLength: 64
position:
title: Position
description: Identifier to reference when renaming installed components
type: string
maxLength: 30
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ModuleType:
required:
- manufacturer
- model
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
manufacturer:
$ref: '#/definitions/NestedManufacturer'
model:
title: Model
type: string
maxLength: 100
minLength: 1
part_number:
title: Part number
description: Discrete part number (optional)
type: string
maxLength: 50
weight:
title: Weight
type: number
format: decimal
x-nullable: true
weight_unit:
title: Weight unit
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Kilograms
- Grams
- Pounds
- Ounces
value:
type: string
enum:
- kg
- g
- lb
- oz
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableModuleType:
required:
- manufacturer
- model
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
manufacturer:
title: Manufacturer
type: integer
model:
title: Model
type: string
maxLength: 100
minLength: 1
part_number:
title: Part number
description: Discrete part number (optional)
type: string
maxLength: 50
weight:
title: Weight
type: number
format: decimal
x-nullable: true
weight_unit:
title: Weight unit
type: string
enum:
- kg
- g
- lb
- oz
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedModule:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module_bay:
$ref: '#/definitions/ModuleNestedModuleBay'
module_type:
$ref: '#/definitions/NestedModuleType'
NestedModuleBay:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
module:
$ref: '#/definitions/NestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
Module:
required:
- device
- module_bay
- module_type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module_bay:
$ref: '#/definitions/NestedModuleBay'
module_type:
$ref: '#/definitions/NestedModuleType'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Offline
- Active
- Planned
- Staged
- Failed
- Decommissioning
value:
type: string
enum:
- offline
- active
- planned
- staged
- failed
- decommissioning
serial:
title: Serial number
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this device
type: string
maxLength: 50
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableModule:
required:
- device
- module_bay
- module_type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module_bay:
title: Module bay
type: integer
module_type:
title: Module type
type: integer
status:
title: Status
type: string
enum:
- offline
- active
- planned
- staged
- failed
- decommissioning
serial:
title: Serial number
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this device
type: string
maxLength: 50
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
Platform:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
manufacturer:
$ref: '#/definitions/NestedManufacturer'
config_template:
$ref: '#/definitions/NestedConfigTemplate'
napalm_driver:
title: NAPALM driver
description: The name of the NAPALM driver to use when interacting with devices
type: string
maxLength: 50
napalm_args:
title: NAPALM arguments
description: Additional arguments to pass when initiating the NAPALM driver
(JSON format)
type: object
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
WritablePlatform:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
manufacturer:
title: Manufacturer
description: Optionally limit this platform to devices of a certain manufacturer
type: integer
x-nullable: true
config_template:
title: Config template
type: integer
x-nullable: true
napalm_driver:
title: NAPALM driver
description: The name of the NAPALM driver to use when interacting with devices
type: string
maxLength: 50
napalm_args:
title: NAPALM arguments
description: Additional arguments to pass when initiating the NAPALM driver
(JSON format)
type: object
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
NestedPowerPanel:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
powerfeed_count:
title: Powerfeed count
type: integer
readOnly: true
PowerFeed:
required:
- power_panel
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
power_panel:
$ref: '#/definitions/NestedPowerPanel'
rack:
$ref: '#/definitions/NestedRack'
name:
title: Name
type: string
maxLength: 100
minLength: 1
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Offline
- Active
- Planned
- Failed
value:
type: string
enum:
- offline
- active
- planned
- failed
default:
value: active
label: Active
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Primary
- Redundant
value:
type: string
enum:
- primary
- redundant
default:
value: primary
label: Primary
supply:
title: Supply
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- AC
- DC
value:
type: string
enum:
- ac
- dc
default:
value: ac
label: AC
phase:
title: Phase
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Single phase
- Three-phase
value:
type: string
enum:
- single-phase
- three-phase
default:
value: single-phase
label: Single phase
voltage:
title: Voltage
type: integer
maximum: 32767
minimum: -32768
amperage:
title: Amperage
type: integer
maximum: 32767
minimum: 1
max_utilization:
title: Max utilization
description: Maximum permissible draw (percentage)
type: integer
maximum: 100
minimum: 1
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritablePowerFeed:
required:
- power_panel
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
power_panel:
title: Power panel
type: integer
rack:
title: Rack
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
status:
title: Status
type: string
enum:
- offline
- active
- planned
- failed
type:
title: Type
type: string
enum:
- primary
- redundant
supply:
title: Supply
type: string
enum:
- ac
- dc
phase:
title: Phase
type: string
enum:
- single-phase
- three-phase
voltage:
title: Voltage
type: integer
maximum: 32767
minimum: -32768
amperage:
title: Amperage
type: integer
maximum: 32767
minimum: 1
max_utilization:
title: Max utilization
description: Maximum permissible draw (percentage)
type: integer
maximum: 100
minimum: 1
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
NestedPowerPortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
x-nullable: true
PowerOutletTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- C5
- C7
- C13
- C15
- C19
- C21
- 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
- NEMA L22-30R
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ITA Type E (CEE 7/5)
- ITA Type F (CEE 7/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
- ITA Multistandard
- USB Type A
- USB Micro B
- USB Type C
- DC Terminal
- HDOT Cx
- Saf-D-Grid
- Neutrik powerCON (20A)
- Neutrik powerCON (32A)
- Neutrik powerCON TRUE1
- Neutrik powerCON TRUE1 TOP
- Ubiquiti SmartPower
- Hardwired
- Other
value:
type: string
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60320-c21
- 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
- nema-l22-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
- ita-multistandard
- usb-a
- usb-micro-b
- usb-c
- dc-terminal
- hdot-cx
- saf-d-grid
- neutrik-powercon-20a
- neutrik-powercon-32a
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
power_port:
$ref: '#/definitions/NestedPowerPortTemplate'
feed_leg:
title: Feed leg
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- A
- B
- C
value:
type: string
enum:
- A
- B
- C
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritablePowerOutletTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60320-c21
- 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
- nema-l22-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
- ita-multistandard
- usb-a
- usb-micro-b
- usb-c
- dc-terminal
- hdot-cx
- saf-d-grid
- neutrik-powercon-20a
- neutrik-powercon-32a
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
power_port:
title: Power port
type: integer
x-nullable: true
feed_leg:
title: Feed leg
description: Phase (for three-phase feeds)
type: string
enum:
- A
- B
- C
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedPowerPort:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
name:
title: Name
type: string
maxLength: 64
minLength: 1
cable:
title: Cable
type: integer
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
x-nullable: true
PowerOutlet:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- C5
- C7
- C13
- C15
- C19
- C21
- 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
- NEMA L22-30R
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ITA Type E (CEE 7/5)
- ITA Type F (CEE 7/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
- ITA Multistandard
- USB Type A
- USB Micro B
- USB Type C
- DC Terminal
- HDOT Cx
- Saf-D-Grid
- Neutrik powerCON (20A)
- Neutrik powerCON (32A)
- Neutrik powerCON TRUE1
- Neutrik powerCON TRUE1 TOP
- Ubiquiti SmartPower
- Hardwired
- Other
value:
type: string
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60320-c21
- 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
- nema-l22-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
- ita-multistandard
- usb-a
- usb-micro-b
- usb-c
- dc-terminal
- hdot-cx
- saf-d-grid
- neutrik-powercon-20a
- neutrik-powercon-32a
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
power_port:
$ref: '#/definitions/NestedPowerPort'
feed_leg:
title: Feed leg
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- A
- B
- C
value:
type: string
enum:
- A
- B
- C
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritablePowerOutlet:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
description: Physical port type
type: string
enum:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60320-c21
- 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
- nema-l22-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
- ita-multistandard
- usb-a
- usb-micro-b
- usb-c
- dc-terminal
- hdot-cx
- saf-d-grid
- neutrik-powercon-20a
- neutrik-powercon-32a
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
power_port:
title: Power port
type: integer
x-nullable: true
feed_leg:
title: Feed leg
description: Phase (for three-phase feeds)
type: string
enum:
- A
- B
- C
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
PowerPanel:
required:
- site
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
site:
$ref: '#/definitions/NestedSite'
location:
$ref: '#/definitions/NestedLocation'
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
powerfeed_count:
title: Powerfeed count
type: integer
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritablePowerPanel:
required:
- site
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
site:
title: Site
type: integer
location:
title: Location
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
powerfeed_count:
title: Powerfeed count
type: integer
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
PowerPortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- C6
- C8
- C14
- C16
- C20
- C22
- 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
- NEMA L22-30P
- CS6361C
- CS6365C
- CS8165C
- CS8265C
- CS8365C
- CS8465C
- ITA Type C (CEE 7/16)
- ITA Type E (CEE 7/6)
- 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 Micro AB
- USB 3.0 Type B
- USB 3.0 Micro B
- DC Terminal
- Saf-D-Grid
- Neutrik powerCON (20A)
- Neutrik powerCON (32A)
- Neutrik powerCON TRUE1
- Neutrik powerCON TRUE1 TOP
- Ubiquiti SmartPower
- Hardwired
- Other
value:
type: string
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60320-c22
- 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
- nema-l22-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-c
- 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-micro-ab
- usb-3-b
- usb-3-micro-b
- dc-terminal
- saf-d-grid
- neutrik-powercon-20
- neutrik-powercon-32
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
maximum_draw:
title: Maximum draw
description: Maximum power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
allocated_draw:
title: Allocated draw
description: Allocated power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritablePowerPortTemplate:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60320-c22
- 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
- nema-l22-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-c
- 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-micro-ab
- usb-3-b
- usb-3-micro-b
- dc-terminal
- saf-d-grid
- neutrik-powercon-20
- neutrik-powercon-32
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
maximum_draw:
title: Maximum draw
description: Maximum power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
allocated_draw:
title: Allocated draw
description: Allocated power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
PowerPort:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- C6
- C8
- C14
- C16
- C20
- C22
- 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
- NEMA L22-30P
- CS6361C
- CS6365C
- CS8165C
- CS8265C
- CS8365C
- CS8465C
- ITA Type C (CEE 7/16)
- ITA Type E (CEE 7/6)
- 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 Micro AB
- USB 3.0 Type B
- USB 3.0 Micro B
- DC Terminal
- Saf-D-Grid
- Neutrik powerCON (20A)
- Neutrik powerCON (32A)
- Neutrik powerCON TRUE1
- Neutrik powerCON TRUE1 TOP
- Ubiquiti SmartPower
- Hardwired
- Other
value:
type: string
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60320-c22
- 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
- nema-l22-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-c
- 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-micro-ab
- usb-3-b
- usb-3-micro-b
- dc-terminal
- saf-d-grid
- neutrik-powercon-20
- neutrik-powercon-32
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
maximum_draw:
title: Maximum draw
description: Maximum power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
allocated_draw:
title: Allocated draw
description: Allocated power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritablePowerPort:
required:
- device
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
description: Physical port type
type: string
enum:
- iec-60320-c6
- iec-60320-c8
- iec-60320-c14
- iec-60320-c16
- iec-60320-c20
- iec-60320-c22
- 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
- nema-l22-30p
- cs6361c
- cs6365c
- cs8165c
- cs8265c
- cs8365c
- cs8465c
- ita-c
- 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-micro-ab
- usb-3-b
- usb-3-micro-b
- dc-terminal
- saf-d-grid
- neutrik-powercon-20
- neutrik-powercon-32
- neutrik-powercon-true1
- neutrik-powercon-true1-top
- ubiquiti-smartpower
- hardwired
- other
maximum_draw:
title: Maximum draw
description: Maximum power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
allocated_draw:
title: Allocated draw
description: Allocated power draw (watts)
type: integer
maximum: 32767
minimum: 1
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
connected_endpoints:
description: |2
Return the appropriate serializer for the type of connected object.
type: array
items:
type: string
x-nullable: true
readOnly: true
connected_endpoints_type:
title: Connected endpoints type
type: string
readOnly: true
connected_endpoints_reachable:
title: Connected endpoints reachable
type: boolean
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
RackReservation:
required:
- rack
- units
- user
- description
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
rack:
$ref: '#/definitions/NestedRack'
units:
type: array
items:
title: Units
type: integer
maximum: 32767
minimum: 0
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
user:
$ref: '#/definitions/NestedUser'
tenant:
$ref: '#/definitions/NestedTenant'
description:
title: Description
type: string
maxLength: 200
minLength: 1
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
WritableRackReservation:
required:
- rack
- units
- user
- description
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
rack:
title: Rack
type: integer
units:
type: array
items:
title: Units
type: integer
maximum: 32767
minimum: 0
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
user:
title: User
type: integer
tenant:
title: Tenant
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
minLength: 1
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
RackRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
rack_count:
title: Rack count
type: integer
readOnly: true
NestedRackRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
rack_count:
title: Rack count
type: integer
readOnly: true
x-nullable: true
Rack:
required:
- name
- site
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
facility_id:
title: Facility ID
type: string
maxLength: 50
x-nullable: true
site:
$ref: '#/definitions/NestedSite'
location:
$ref: '#/definitions/NestedLocation'
tenant:
$ref: '#/definitions/NestedTenant'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Reserved
- Available
- Planned
- Active
- Deprecated
value:
type: string
enum:
- reserved
- available
- planned
- active
- deprecated
role:
$ref: '#/definitions/NestedRackRole'
serial:
title: Serial number
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this rack
type: string
maxLength: 50
x-nullable: true
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 2-post frame
- 4-post frame
- 4-post cabinet
- Wall-mounted frame
- Wall-mounted frame (vertical)
- Wall-mounted cabinet
- Wall-mounted cabinet (vertical)
value:
type: string
enum:
- 2-post-frame
- 4-post-frame
- 4-post-cabinet
- wall-frame
- wall-frame-vertical
- wall-cabinet
- wall-cabinet-vertical
width:
title: Width
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 10 inches
- 19 inches
- 21 inches
- 23 inches
value:
type: integer
enum:
- 10
- 19
- 21
- 23
u_height:
title: Height (U)
description: Height in rack units
type: integer
maximum: 100
minimum: 1
weight:
title: Weight
type: number
format: decimal
x-nullable: true
max_weight:
title: Max weight
description: Maximum load capacity for the rack
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
weight_unit:
title: Weight unit
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Kilograms
- Grams
- Pounds
- Ounces
value:
type: string
enum:
- kg
- g
- lb
- oz
desc_units:
title: Descending units
description: Units are numbered top-to-bottom
type: boolean
outer_width:
title: Outer width
description: Outer dimension of rack (width)
type: integer
maximum: 32767
minimum: 0
x-nullable: true
outer_depth:
title: Outer depth
description: Outer dimension of rack (depth)
type: integer
maximum: 32767
minimum: 0
x-nullable: true
outer_unit:
title: Outer unit
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Millimeters
- Inches
value:
type: string
enum:
- mm
- in
mounting_depth:
title: Mounting depth
description: Maximum depth of a mounted device, in millimeters. For four-post
racks, this is the distance between the front and rear rails.
type: integer
maximum: 32767
minimum: 0
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
powerfeed_count:
title: Powerfeed count
type: integer
readOnly: true
WritableRack:
required:
- name
- site
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
facility_id:
title: Facility ID
type: string
maxLength: 50
x-nullable: true
site:
title: Site
type: integer
location:
title: Location
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
status:
title: Status
type: string
enum:
- reserved
- available
- planned
- active
- deprecated
role:
title: Role
description: Functional role
type: integer
x-nullable: true
serial:
title: Serial number
type: string
maxLength: 50
asset_tag:
title: Asset tag
description: A unique tag used to identify this rack
type: string
maxLength: 50
x-nullable: true
type:
title: Type
type: string
enum:
- 2-post-frame
- 4-post-frame
- 4-post-cabinet
- wall-frame
- wall-frame-vertical
- wall-cabinet
- wall-cabinet-vertical
width:
title: Width
description: Rail-to-rail width
type: integer
enum:
- 10
- 19
- 21
- 23
u_height:
title: Height (U)
description: Height in rack units
type: integer
maximum: 100
minimum: 1
weight:
title: Weight
type: number
format: decimal
x-nullable: true
max_weight:
title: Max weight
description: Maximum load capacity for the rack
type: integer
maximum: 2147483647
minimum: 0
x-nullable: true
weight_unit:
title: Weight unit
type: string
enum:
- kg
- g
- lb
- oz
desc_units:
title: Descending units
description: Units are numbered top-to-bottom
type: boolean
outer_width:
title: Outer width
description: Outer dimension of rack (width)
type: integer
maximum: 32767
minimum: 0
x-nullable: true
outer_depth:
title: Outer depth
description: Outer dimension of rack (depth)
type: integer
maximum: 32767
minimum: 0
x-nullable: true
outer_unit:
title: Outer unit
type: string
enum:
- mm
- in
mounting_depth:
title: Mounting depth
description: Maximum depth of a mounted device, in millimeters. For four-post
racks, this is the distance between the front and rear rails.
type: integer
maximum: 32767
minimum: 0
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
powerfeed_count:
title: Powerfeed count
type: integer
readOnly: true
RackUnit:
type: object
properties:
id:
title: Id
type: number
format: decimal
readOnly: true
name:
title: Name
type: string
readOnly: true
minLength: 1
face:
title: Face
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Front
- Rear
value:
type: string
enum:
- front
- rear
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
occupied:
title: Occupied
type: boolean
readOnly: true
display:
title: Display
type: string
readOnly: true
RearPortTemplate:
required:
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
$ref: '#/definitions/NestedDeviceType'
module_type:
$ref: '#/definitions/NestedModuleType'
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 8P8C
- 8P6C
- 8P4C
- 8P2C
- 6P6C
- 6P4C
- 6P2C
- 4P4C
- 4P2C
- GG45
- TERA 4P
- TERA 2P
- TERA 1P
- 110 Punch
- BNC
- F Connector
- N Connector
- MRJ21
- FC
- LC
- LC/PC
- LC/UPC
- LC/APC
- LSH
- LSH/PC
- LSH/UPC
- LSH/APC
- MPO
- MTRJ
- SC
- SC/PC
- SC/UPC
- SC/APC
- ST
- CS
- SN
- SMA 905
- SMA 906
- URM-P2
- URM-P4
- URM-P8
- Splice
- Other
value:
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
positions:
title: Positions
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableRearPortTemplate:
required:
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device_type:
title: Device type
type: integer
x-nullable: true
module_type:
title: Module type
type: integer
x-nullable: true
name:
title: Name
description: |2
{module} is accepted as a substitution for the module bay position when attached to a module type.
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
positions:
title: Positions
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
RearPort:
required:
- device
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
module:
$ref: '#/definitions/ComponentNestedModule'
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- 8P8C
- 8P6C
- 8P4C
- 8P2C
- 6P6C
- 6P4C
- 6P2C
- 4P4C
- 4P2C
- GG45
- TERA 4P
- TERA 2P
- TERA 1P
- 110 Punch
- BNC
- F Connector
- N Connector
- MRJ21
- FC
- LC
- LC/PC
- LC/UPC
- LC/APC
- LSH
- LSH/PC
- LSH/UPC
- LSH/APC
- MPO
- MTRJ
- SC
- SC/PC
- SC/UPC
- SC/APC
- ST
- CS
- SN
- SMA 905
- SMA 906
- URM-P2
- URM-P4
- URM-P8
- Splice
- Other
value:
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
positions:
title: Positions
description: Number of front ports which may be mapped
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
WritableRearPort:
required:
- device
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
module:
title: Module
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
label:
title: Label
description: Physical label
type: string
maxLength: 64
type:
title: Type
type: string
enum:
- 8p8c
- 8p6c
- 8p4c
- 8p2c
- 6p6c
- 6p4c
- 6p2c
- 4p4c
- 4p2c
- gg45
- tera-4p
- tera-2p
- tera-1p
- 110-punch
- bnc
- f
- n
- mrj21
- fc
- lc
- lc-pc
- lc-upc
- lc-apc
- lsh
- lsh-pc
- lsh-upc
- lsh-apc
- mpo
- mtrj
- sc
- sc-pc
- sc-upc
- sc-apc
- st
- cs
- sn
- sma-905
- sma-906
- urm-p2
- urm-p4
- urm-p8
- splice
- other
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
positions:
title: Positions
description: Number of front ports which may be mapped
type: integer
maximum: 1024
minimum: 1
description:
title: Description
type: string
maxLength: 200
mark_connected:
title: Mark connected
description: Treat as if a cable is connected
type: boolean
cable:
$ref: '#/definitions/NestedCable'
cable_end:
title: Cable end
type: string
readOnly: true
minLength: 1
link_peers:
description: |2
Return the appropriate serializer for the link termination model.
type: array
items:
type: string
x-nullable: true
readOnly: true
link_peers_type:
title: Link peers type
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
_occupied:
title: occupied
type: boolean
readOnly: true
NestedRegion:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
site_count:
title: Site count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
x-nullable: true
Region:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
$ref: '#/definitions/NestedRegion'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
site_count:
title: Site count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritableRegion:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
title: Parent
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
site_count:
title: Site count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
NestedSiteGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
site_count:
title: Site count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
x-nullable: true
SiteGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
$ref: '#/definitions/NestedSiteGroup'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
site_count:
title: Site count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritableSiteGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
title: Parent
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
site_count:
title: Site count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
Site:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Full name of the site
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Planned
- Staging
- Active
- Decommissioning
- Retired
value:
type: string
enum:
- planned
- staging
- active
- decommissioning
- retired
region:
$ref: '#/definitions/NestedRegion'
group:
$ref: '#/definitions/NestedSiteGroup'
tenant:
$ref: '#/definitions/NestedTenant'
facility:
title: Facility
description: Local facility ID or description
type: string
maxLength: 50
time_zone:
title: Time zone
type: string
x-nullable: true
description:
title: Description
type: string
maxLength: 200
physical_address:
title: Physical address
description: Physical location of the building
type: string
maxLength: 200
shipping_address:
title: Shipping address
description: If different from the physical address
type: string
maxLength: 200
latitude:
title: Latitude
description: GPS coordinate in decimal format (xx.yyyyyy)
type: number
format: decimal
x-nullable: true
longitude:
title: Longitude
description: GPS coordinate in decimal format (xx.yyyyyy)
type: number
format: decimal
x-nullable: true
comments:
title: Comments
type: string
asns:
type: array
items:
$ref: '#/definitions/NestedASN'
uniqueItems: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
device_count:
title: Device count
type: integer
readOnly: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
rack_count:
title: Rack count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
WritableSite:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Full name of the site
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
status:
title: Status
type: string
enum:
- planned
- staging
- active
- decommissioning
- retired
region:
title: Region
type: integer
x-nullable: true
group:
title: Group
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
facility:
title: Facility
description: Local facility ID or description
type: string
maxLength: 50
time_zone:
title: Time zone
type: string
x-nullable: true
description:
title: Description
type: string
maxLength: 200
physical_address:
title: Physical address
description: Physical location of the building
type: string
maxLength: 200
shipping_address:
title: Shipping address
description: If different from the physical address
type: string
maxLength: 200
latitude:
title: Latitude
description: GPS coordinate in decimal format (xx.yyyyyy)
type: number
format: decimal
x-nullable: true
longitude:
title: Longitude
description: GPS coordinate in decimal format (xx.yyyyyy)
type: number
format: decimal
x-nullable: true
comments:
title: Comments
type: string
asns:
type: array
items:
type: integer
uniqueItems: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
device_count:
title: Device count
type: integer
readOnly: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
rack_count:
title: Rack count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
VirtualChassis:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
domain:
title: Domain
type: string
maxLength: 30
master:
$ref: '#/definitions/NestedDevice'
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
member_count:
title: Member count
type: integer
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableVirtualChassis:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
domain:
title: Domain
type: string
maxLength: 30
master:
title: Master
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
member_count:
title: Member count
type: integer
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
VirtualDeviceContext:
required:
- name
- device
- status
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
device:
$ref: '#/definitions/NestedDevice'
identifier:
title: Identifier
description: Numeric identifier unique to the parent device
type: integer
maximum: 32767
minimum: 0
x-nullable: true
tenant:
$ref: '#/definitions/NestedTenant'
primary_ip:
$ref: '#/definitions/NestedIPAddress'
primary_ip4:
$ref: '#/definitions/NestedIPAddress'
primary_ip6:
$ref: '#/definitions/NestedIPAddress'
status:
title: Status
type: string
enum:
- active
- planned
- offline
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
interface_count:
title: Interface count
type: integer
readOnly: true
WritableVirtualDeviceContext:
required:
- name
- status
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
device:
title: Device
type: integer
x-nullable: true
identifier:
title: Identifier
description: Numeric identifier unique to the parent device
type: integer
maximum: 32767
minimum: 0
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
primary_ip:
title: Primary ip
type: string
readOnly: true
primary_ip4:
title: Primary IPv4
type: integer
x-nullable: true
primary_ip6:
title: Primary IPv6
type: integer
x-nullable: true
status:
title: Status
type: string
enum:
- active
- planned
- offline
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
interface_count:
title: Interface count
type: integer
readOnly: true
NestedClusterType:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
cluster_count:
title: Cluster count
type: integer
readOnly: true
NestedClusterGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
cluster_count:
title: Cluster count
type: integer
readOnly: true
NestedTenantGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
tenant_count:
title: Tenant count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
NestedDataFile:
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
path:
title: Path
description: File path relative to the data source's root
type: string
readOnly: true
minLength: 1
ConfigContext:
required:
- name
- data
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
weight:
title: Weight
type: integer
maximum: 32767
minimum: 0
description:
title: Description
type: string
maxLength: 200
is_active:
title: Is active
type: boolean
regions:
type: array
items:
$ref: '#/definitions/NestedRegion'
uniqueItems: true
site_groups:
type: array
items:
$ref: '#/definitions/NestedSiteGroup'
uniqueItems: true
sites:
type: array
items:
$ref: '#/definitions/NestedSite'
uniqueItems: true
locations:
type: array
items:
$ref: '#/definitions/NestedLocation'
uniqueItems: true
device_types:
type: array
items:
$ref: '#/definitions/NestedDeviceType'
uniqueItems: true
roles:
type: array
items:
$ref: '#/definitions/NestedDeviceRole'
uniqueItems: true
platforms:
type: array
items:
$ref: '#/definitions/NestedPlatform'
uniqueItems: true
cluster_types:
type: array
items:
$ref: '#/definitions/NestedClusterType'
uniqueItems: true
cluster_groups:
type: array
items:
$ref: '#/definitions/NestedClusterGroup'
uniqueItems: true
clusters:
type: array
items:
$ref: '#/definitions/NestedCluster'
uniqueItems: true
tenant_groups:
type: array
items:
$ref: '#/definitions/NestedTenantGroup'
uniqueItems: true
tenants:
type: array
items:
$ref: '#/definitions/NestedTenant'
uniqueItems: true
tags:
type: array
items:
type: string
format: slug
pattern: ^[-\w]+$
uniqueItems: true
data_source:
$ref: '#/definitions/NestedDataSource'
data_path:
title: Data path
description: Path to remote file (relative to data source root)
type: string
readOnly: true
minLength: 1
data_file:
$ref: '#/definitions/NestedDataFile'
data_synced:
title: Data synced
type: string
format: date-time
readOnly: true
x-nullable: true
data:
title: Data
type: object
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableConfigContext:
required:
- name
- data
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
weight:
title: Weight
type: integer
maximum: 32767
minimum: 0
description:
title: Description
type: string
maxLength: 200
is_active:
title: Is active
type: boolean
regions:
type: array
items:
type: integer
uniqueItems: true
site_groups:
type: array
items:
type: integer
uniqueItems: true
sites:
type: array
items:
type: integer
uniqueItems: true
locations:
type: array
items:
type: integer
uniqueItems: true
device_types:
type: array
items:
type: integer
uniqueItems: true
roles:
type: array
items:
type: integer
uniqueItems: true
platforms:
type: array
items:
type: integer
uniqueItems: true
cluster_types:
type: array
items:
type: integer
uniqueItems: true
cluster_groups:
type: array
items:
type: integer
uniqueItems: true
clusters:
type: array
items:
type: integer
uniqueItems: true
tenant_groups:
type: array
items:
type: integer
uniqueItems: true
tenants:
type: array
items:
type: integer
uniqueItems: true
tags:
type: array
items:
type: string
format: slug
pattern: ^[-\w]+$
uniqueItems: true
data_source:
title: Data source
description: Remote data source
type: integer
x-nullable: true
data_path:
title: Data path
description: Path to remote file (relative to data source root)
type: string
readOnly: true
minLength: 1
data_file:
title: Data file
type: integer
x-nullable: true
data_synced:
title: Data synced
type: string
format: date-time
readOnly: true
x-nullable: true
data:
title: Data
type: object
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ConfigTemplate:
required:
- name
- template_code
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
environment_params:
title: Environment params
description: Any <a href="https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment">additional
parameters</a> to pass when constructing the Jinja2 environment.
type: object
x-nullable: true
template_code:
title: Template code
description: Jinja2 template code.
type: string
minLength: 1
data_source:
$ref: '#/definitions/NestedDataSource'
data_path:
title: Data path
description: Path to remote file (relative to data source root)
type: string
readOnly: true
minLength: 1
data_file:
$ref: '#/definitions/NestedDataFile'
data_synced:
title: Data synced
type: string
format: date-time
readOnly: true
x-nullable: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableConfigTemplate:
required:
- name
- template_code
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
environment_params:
title: Environment params
description: Any <a href="https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment">additional
parameters</a> to pass when constructing the Jinja2 environment.
type: object
x-nullable: true
template_code:
title: Template code
description: Jinja2 template code.
type: string
minLength: 1
data_source:
title: Data source
description: Remote data source
type: integer
x-nullable: true
data_path:
title: Data path
description: Path to remote file (relative to data source root)
type: string
readOnly: true
minLength: 1
data_file:
title: Data file
type: integer
x-nullable: true
data_synced:
title: Data synced
type: string
format: date-time
readOnly: true
x-nullable: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ContentType:
required:
- app_label
- model
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
app_label:
title: App label
type: string
maxLength: 100
minLength: 1
model:
title: Python model class name
type: string
maxLength: 100
minLength: 1
CustomField:
required:
- content_types
- type
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Text
- Text (long)
- Integer
- Decimal
- Boolean (true/false)
- Date
- Date & time
- URL
- JSON
- Selection
- Multiple selection
- Object
- Multiple objects
value:
type: string
enum:
- text
- longtext
- integer
- decimal
- boolean
- date
- datetime
- url
- json
- select
- multiselect
- object
- multiobject
object_type:
title: Object type
type: string
data_type:
title: Data type
type: string
readOnly: true
name:
title: Name
description: Internal field name
type: string
pattern: ^[a-z0-9_]+$
maxLength: 50
minLength: 1
label:
title: Label
description: Name of the field as displayed to users (if not provided, the
field's name will be used)
type: string
maxLength: 50
group_name:
title: Group name
description: Custom fields within the same group will be displayed together
type: string
maxLength: 50
description:
title: Description
type: string
maxLength: 200
required:
title: Required
description: If true, this field is required when creating new objects or
editing an existing object.
type: boolean
search_weight:
title: Search weight
description: Weighting for search. Lower values are considered more important.
Fields with a search weight of zero will be ignored.
type: integer
maximum: 32767
minimum: 0
filter_logic:
title: Filter logic
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Disabled
- Loose
- Exact
value:
type: string
enum:
- disabled
- loose
- exact
ui_visibility:
title: Ui visibility
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Read/Write
- Read-only
- Hidden
value:
type: string
enum:
- read-write
- read-only
- hidden
is_cloneable:
title: Cloneable
description: Replicate this value when cloning objects
type: boolean
default:
title: Default
description: Default value for the field (must be a JSON value). Encapsulate
strings with double quotes (e.g. "Foo").
type: object
x-nullable: true
weight:
title: Display weight
description: Fields with higher weights appear lower in a form.
type: integer
maximum: 32767
minimum: 0
validation_minimum:
title: Minimum value
description: Minimum allowed value (for numeric fields)
type: integer
maximum: 2147483647
minimum: -2147483648
x-nullable: true
validation_maximum:
title: Maximum value
description: Maximum allowed value (for numeric fields)
type: integer
maximum: 2147483647
minimum: -2147483648
x-nullable: true
validation_regex:
title: Validation regex
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.
type: string
maxLength: 500
choices:
description: Comma-separated list of available choices (for selection fields)
type: array
items:
title: Choices
type: string
maxLength: 100
minLength: 1
x-nullable: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableCustomField:
required:
- content_types
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
type:
title: Type
description: The type of data this custom field holds
type: string
enum:
- text
- longtext
- integer
- decimal
- boolean
- date
- datetime
- url
- json
- select
- multiselect
- object
- multiobject
object_type:
title: Object type
type: string
data_type:
title: Data type
type: string
readOnly: true
name:
title: Name
description: Internal field name
type: string
pattern: ^[a-z0-9_]+$
maxLength: 50
minLength: 1
label:
title: Label
description: Name of the field as displayed to users (if not provided, the
field's name will be used)
type: string
maxLength: 50
group_name:
title: Group name
description: Custom fields within the same group will be displayed together
type: string
maxLength: 50
description:
title: Description
type: string
maxLength: 200
required:
title: Required
description: If true, this field is required when creating new objects or
editing an existing object.
type: boolean
search_weight:
title: Search weight
description: Weighting for search. Lower values are considered more important.
Fields with a search weight of zero will be ignored.
type: integer
maximum: 32767
minimum: 0
filter_logic:
title: Filter logic
description: Loose matches any instance of a given string; exact matches the
entire field.
type: string
enum:
- disabled
- loose
- exact
ui_visibility:
title: UI visibility
description: Specifies the visibility of custom field in the UI
type: string
enum:
- read-write
- read-only
- hidden
is_cloneable:
title: Cloneable
description: Replicate this value when cloning objects
type: boolean
default:
title: Default
description: Default value for the field (must be a JSON value). Encapsulate
strings with double quotes (e.g. "Foo").
type: object
x-nullable: true
weight:
title: Display weight
description: Fields with higher weights appear lower in a form.
type: integer
maximum: 32767
minimum: 0
validation_minimum:
title: Minimum value
description: Minimum allowed value (for numeric fields)
type: integer
maximum: 2147483647
minimum: -2147483648
x-nullable: true
validation_maximum:
title: Maximum value
description: Maximum allowed value (for numeric fields)
type: integer
maximum: 2147483647
minimum: -2147483648
x-nullable: true
validation_regex:
title: Validation regex
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.
type: string
maxLength: 500
choices:
description: Comma-separated list of available choices (for selection fields)
type: array
items:
title: Choices
type: string
maxLength: 100
minLength: 1
x-nullable: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
CustomLink:
required:
- content_types
- name
- link_text
- link_url
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
enabled:
title: Enabled
type: boolean
link_text:
title: Link text
description: Jinja2 template code for link text
type: string
minLength: 1
link_url:
title: Link URL
description: Jinja2 template code for link URL
type: string
minLength: 1
weight:
title: Weight
type: integer
maximum: 32767
minimum: 0
group_name:
title: Group name
description: Links with the same group will appear as a dropdown menu
type: string
maxLength: 50
button_class:
title: Button class
description: The class of the first link in a group will be used for the dropdown
button
type: string
enum:
- outline-dark
- blue
- indigo
- purple
- pink
- red
- orange
- yellow
- green
- teal
- cyan
- gray
- black
- white
- ghost-dark
new_window:
title: New window
description: Force link to open in a new window
type: boolean
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
Dashboard:
type: object
properties:
layout:
title: Layout
type: object
config:
title: Config
type: object
ExportTemplate:
required:
- content_types
- name
- template_code
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
template_code:
title: Template code
description: Jinja2 template code. The list of objects being exported is passed
as a context variable named <code>queryset</code>.
type: string
minLength: 1
mime_type:
title: MIME type
description: Defaults to <code>text/plain</code>
type: string
maxLength: 50
file_extension:
title: File extension
description: Extension to append to the rendered filename
type: string
maxLength: 15
as_attachment:
title: As attachment
description: Download file as attachment
type: boolean
data_source:
$ref: '#/definitions/NestedDataSource'
data_path:
title: Data path
description: Path to remote file (relative to data source root)
type: string
readOnly: true
minLength: 1
data_file:
$ref: '#/definitions/NestedDataFile'
data_synced:
title: Data synced
type: string
format: date-time
readOnly: true
x-nullable: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableExportTemplate:
required:
- content_types
- name
- template_code
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
template_code:
title: Template code
description: Jinja2 template code. The list of objects being exported is passed
as a context variable named <code>queryset</code>.
type: string
minLength: 1
mime_type:
title: MIME type
description: Defaults to <code>text/plain</code>
type: string
maxLength: 50
file_extension:
title: File extension
description: Extension to append to the rendered filename
type: string
maxLength: 15
as_attachment:
title: As attachment
description: Download file as attachment
type: boolean
data_source:
title: Data source
description: Remote data source
type: integer
x-nullable: true
data_path:
title: Data path
description: Path to remote file (relative to data source root)
type: string
readOnly: true
minLength: 1
data_file:
title: Data file
type: integer
x-nullable: true
data_synced:
title: Data synced
type: string
format: date-time
readOnly: true
x-nullable: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ImageAttachment:
required:
- content_type
- object_id
- image_height
- image_width
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_type:
title: Content type
type: string
object_id:
title: Object id
type: integer
maximum: 9223372036854775807
minimum: 0
parent:
title: Parent
type: object
readOnly: true
name:
title: Name
type: string
maxLength: 50
image:
title: Image
type: string
readOnly: true
format: uri
image_height:
title: Image height
type: integer
maximum: 32767
minimum: 0
image_width:
title: Image width
type: integer
maximum: 32767
minimum: 0
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
JournalEntry:
required:
- assigned_object_type
- assigned_object_id
- comments
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
assigned_object_type:
title: Assigned object type
type: string
assigned_object_id:
title: Assigned object id
type: integer
maximum: 9223372036854775807
minimum: 0
assigned_object:
title: Assigned object
type: object
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
created_by:
title: Created by
type: integer
x-nullable: true
kind:
title: Kind
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Info
- Success
- Warning
- Danger
value:
type: string
enum:
- info
- success
- warning
- danger
comments:
title: Comments
type: string
minLength: 1
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableJournalEntry:
required:
- assigned_object_type
- assigned_object_id
- comments
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
assigned_object_type:
title: Assigned object type
type: string
assigned_object_id:
title: Assigned object id
type: integer
maximum: 9223372036854775807
minimum: 0
assigned_object:
title: Assigned object
type: object
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
created_by:
title: Created by
type: integer
x-nullable: true
kind:
title: Kind
type: string
enum:
- info
- success
- warning
- danger
comments:
title: Comments
type: string
minLength: 1
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ObjectChange:
required:
- changed_object_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
time:
title: Time
type: string
format: date-time
readOnly: true
user:
$ref: '#/definitions/NestedUser'
user_name:
title: User name
type: string
readOnly: true
minLength: 1
request_id:
title: Request id
type: string
format: uuid
readOnly: true
action:
title: Action
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Created
- Updated
- Deleted
value:
type: string
enum:
- create
- update
- delete
readOnly: true
changed_object_type:
title: Changed object type
type: string
readOnly: true
changed_object_id:
title: Changed object id
type: integer
maximum: 9223372036854775807
minimum: 0
changed_object:
title: Changed object
description: |2
Serialize a nested representation of the changed object.
type: object
readOnly: true
prechange_data:
title: Prechange data
type: object
readOnly: true
x-nullable: true
postchange_data:
title: Postchange data
type: object
readOnly: true
x-nullable: true
SavedFilter:
required:
- content_types
- name
- slug
- parameters
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
user:
title: User
type: integer
x-nullable: true
weight:
title: Weight
type: integer
maximum: 32767
minimum: 0
enabled:
title: Enabled
type: boolean
shared:
title: Shared
type: boolean
parameters:
title: Parameters
type: object
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
Tag:
required:
- name
- slug
type: object
properties:
id:
title: Id
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
maxLength: 100
minLength: 1
color:
title: Color
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
minLength: 1
description:
title: Description
type: string
maxLength: 200
tagged_items:
title: Tagged items
type: integer
readOnly: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
Webhook:
required:
- content_types
- name
- payload_url
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_types:
type: array
items:
type: string
uniqueItems: true
name:
title: Name
type: string
maxLength: 150
minLength: 1
type_create:
title: Type create
description: Triggers when a matching object is created.
type: boolean
type_update:
title: Type update
description: Triggers when a matching object is updated.
type: boolean
type_delete:
title: Type delete
description: Triggers when a matching object is deleted.
type: boolean
type_job_start:
title: Type job start
description: Triggers when a job for a matching object is started.
type: boolean
type_job_end:
title: Type job end
description: Triggers when a job for a matching object terminates.
type: boolean
payload_url:
title: URL
description: This URL will be called using the HTTP method defined when the
webhook is called. Jinja2 template processing is supported with the same
context as the request body.
type: string
maxLength: 500
minLength: 1
enabled:
title: Enabled
type: boolean
http_method:
title: HTTP method
type: string
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
http_content_type:
title: HTTP content type
description: The complete list of official content types is available <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">here</a>.
type: string
maxLength: 100
minLength: 1
additional_headers:
title: Additional headers
description: 'User-supplied HTTP headers to be sent with the request in addition
to the HTTP content type. Headers should be defined in the format <code>Name:
Value</code>. Jinja2 template processing is supported with the same context
as the request body (below).'
type: string
body_template:
title: Body template
description: 'Jinja2 template for a custom request body. If blank, a JSON
object representing the change will be included. Available context data
includes: <code>event</code>, <code>model</code>, <code>timestamp</code>,
<code>username</code>, <code>request_id</code>, and <code>data</code>.'
type: string
secret:
title: Secret
description: When provided, the request will include a 'X-Hook-Signature'
header containing a HMAC hex digest of the payload body using the secret
as the key. The secret is not transmitted in the request.
type: string
maxLength: 255
conditions:
title: Conditions
description: A set of conditions which determine whether the webhook will
be generated.
type: object
x-nullable: true
ssl_verification:
title: SSL verification
description: Enable SSL certificate verification. Disable with caution!
type: boolean
ca_file_path:
title: CA File Path
description: The specific CA certificate file to use for SSL verification.
Leave blank to use the system defaults.
type: string
maxLength: 4096
x-nullable: true
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedRIR:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
aggregate_count:
title: Aggregate count
type: integer
readOnly: true
Aggregate:
required:
- prefix
- rir
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- IPv4
- IPv6
value:
type: integer
enum:
- 4
- 6
readOnly: true
prefix:
title: Prefix
description: IPv4 or IPv6 network
type: string
rir:
$ref: '#/definitions/NestedRIR'
tenant:
$ref: '#/definitions/NestedTenant'
date_added:
title: Date added
type: string
format: date
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableAggregate:
required:
- prefix
- rir
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
type: string
readOnly: true
prefix:
title: Prefix
description: IPv4 or IPv6 network
type: string
rir:
title: RIR
description: Regional Internet Registry responsible for this IP space
type: integer
tenant:
title: Tenant
type: integer
x-nullable: true
date_added:
title: Date added
type: string
format: date
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ASNRange:
required:
- name
- slug
- rir
- start
- end
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
rir:
$ref: '#/definitions/NestedRIR'
start:
title: Start
type: integer
maximum: 4294967295
minimum: 1
end:
title: End
type: integer
maximum: 4294967295
minimum: 1
tenant:
$ref: '#/definitions/NestedTenant'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
asn_count:
title: Asn count
type: integer
readOnly: true
WritableASNRange:
required:
- name
- slug
- rir
- start
- end
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
rir:
title: RIR
type: integer
start:
title: Start
type: integer
maximum: 4294967295
minimum: 1
end:
title: End
type: integer
maximum: 4294967295
minimum: 1
tenant:
title: Tenant
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
asn_count:
title: Asn count
type: integer
readOnly: true
AvailableASN:
type: object
properties:
asn:
title: Asn
type: integer
readOnly: true
ASN:
required:
- asn
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
asn:
title: ASN
description: 16- or 32-bit autonomous system number
type: integer
maximum: 4294967295
minimum: 1
rir:
$ref: '#/definitions/NestedRIR'
tenant:
$ref: '#/definitions/NestedTenant'
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
site_count:
title: Site count
type: integer
readOnly: true
provider_count:
title: Provider count
type: integer
readOnly: true
WritableASN:
required:
- asn
- rir
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
asn:
title: ASN
description: 16- or 32-bit autonomous system number
type: integer
maximum: 4294967295
minimum: 1
rir:
title: RIR
description: Regional Internet Registry responsible for this AS number space
type: integer
tenant:
title: Tenant
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
site_count:
title: Site count
type: integer
readOnly: true
provider_count:
title: Provider count
type: integer
readOnly: true
NestedFHRPGroup:
required:
- protocol
- group_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
protocol:
title: Protocol
type: string
enum:
- vrrp2
- vrrp3
- carp
- clusterxl
- hsrp
- glbp
- other
group_id:
title: Group ID
type: integer
maximum: 32767
minimum: 0
FHRPGroupAssignment:
required:
- group
- interface_type
- interface_id
- priority
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
group:
$ref: '#/definitions/NestedFHRPGroup'
interface_type:
title: Interface type
type: string
interface_id:
title: Interface id
type: integer
maximum: 9223372036854775807
minimum: 0
interface:
title: Interface
type: object
readOnly: true
priority:
title: Priority
type: integer
maximum: 255
minimum: 0
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableFHRPGroupAssignment:
required:
- group
- interface_type
- interface_id
- priority
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
group:
title: Group
type: integer
interface_type:
title: Interface type
type: string
interface_id:
title: Interface id
type: integer
maximum: 9223372036854775807
minimum: 0
interface:
title: Interface
type: object
readOnly: true
priority:
title: Priority
type: integer
maximum: 255
minimum: 0
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
FHRPGroup:
required:
- protocol
- group_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
name:
title: Name
type: string
maxLength: 100
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
protocol:
title: Protocol
type: string
enum:
- vrrp2
- vrrp3
- carp
- clusterxl
- hsrp
- glbp
- other
group_id:
title: Group ID
type: integer
maximum: 32767
minimum: 0
auth_type:
title: Authentication type
type: string
enum:
- plaintext
- md5
auth_key:
title: Authentication key
type: string
maxLength: 255
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ip_addresses:
type: array
items:
$ref: '#/definitions/NestedIPAddress'
readOnly: true
IPAddress:
required:
- address
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- IPv4
- IPv6
value:
type: integer
enum:
- 4
- 6
readOnly: true
address:
title: Address
description: IPv4 or IPv6 address (with mask)
type: string
vrf:
$ref: '#/definitions/NestedVRF'
tenant:
$ref: '#/definitions/NestedTenant'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Active
- Reserved
- Deprecated
- DHCP
- SLAAC
value:
type: string
enum:
- active
- reserved
- deprecated
- dhcp
- slaac
role:
title: Role
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Loopback
- Secondary
- Anycast
- VIP
- VRRP
- HSRP
- GLBP
- CARP
value:
type: string
enum:
- loopback
- secondary
- anycast
- vip
- vrrp
- hsrp
- glbp
- carp
assigned_object_type:
title: Assigned object type
type: string
x-nullable: true
assigned_object_id:
title: Assigned object id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
assigned_object:
title: Assigned object
type: object
readOnly: true
nat_inside:
$ref: '#/definitions/NestedIPAddress'
nat_outside:
type: array
items:
$ref: '#/definitions/NestedIPAddress'
readOnly: true
dns_name:
title: DNS Name
description: Hostname or FQDN (not case-sensitive)
type: string
pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$
maxLength: 255
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableIPAddress:
required:
- address
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
type: string
readOnly: true
address:
title: Address
description: IPv4 or IPv6 address (with mask)
type: string
vrf:
title: VRF
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
status:
title: Status
description: The operational status of this IP
type: string
enum:
- active
- reserved
- deprecated
- dhcp
- slaac
role:
title: Role
description: The functional role of this IP
type: string
enum:
- loopback
- secondary
- anycast
- vip
- vrrp
- hsrp
- glbp
- carp
assigned_object_type:
title: Assigned object type
type: string
x-nullable: true
assigned_object_id:
title: Assigned object id
type: integer
maximum: 9223372036854775807
minimum: 0
x-nullable: true
assigned_object:
title: Assigned object
type: object
readOnly: true
nat_inside:
title: NAT (Inside)
description: The IP for which this address is the "outside" IP
type: integer
x-nullable: true
nat_outside:
type: array
items:
$ref: '#/definitions/NestedIPAddress'
readOnly: true
dns_name:
title: DNS Name
description: Hostname or FQDN (not case-sensitive)
type: string
pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$
maxLength: 255
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
prefix_count:
title: Prefix count
type: integer
readOnly: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
x-nullable: true
IPRange:
required:
- start_address
- end_address
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- IPv4
- IPv6
value:
type: integer
enum:
- 4
- 6
readOnly: true
start_address:
title: Start address
description: IPv4 or IPv6 address (with mask)
type: string
end_address:
title: End address
description: IPv4 or IPv6 address (with mask)
type: string
size:
title: Size
type: integer
readOnly: true
vrf:
$ref: '#/definitions/NestedVRF'
tenant:
$ref: '#/definitions/NestedTenant'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Active
- Reserved
- Deprecated
value:
type: string
enum:
- active
- reserved
- deprecated
role:
$ref: '#/definitions/NestedRole'
mark_utilized:
title: Mark utilized
description: Treat as 100% utilized
type: boolean
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
children:
title: Children
type: integer
readOnly: true
WritableIPRange:
required:
- start_address
- end_address
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
type: string
readOnly: true
start_address:
title: Start address
description: IPv4 or IPv6 address (with mask)
type: string
end_address:
title: End address
description: IPv4 or IPv6 address (with mask)
type: string
size:
title: Size
type: integer
readOnly: true
vrf:
title: VRF
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
status:
title: Status
description: Operational status of this range
type: string
enum:
- active
- reserved
- deprecated
role:
title: Role
description: The primary function of this range
type: integer
x-nullable: true
mark_utilized:
title: Mark utilized
description: Treat as 100% utilized
type: boolean
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
children:
title: Children
type: integer
readOnly: true
AvailableIP:
type: object
properties:
family:
title: Family
type: integer
readOnly: true
address:
title: Address
type: string
readOnly: true
minLength: 1
vrf:
$ref: '#/definitions/NestedVRF'
WritableAvailableIP:
type: object
properties:
family:
title: Family
type: integer
readOnly: true
address:
title: Address
type: string
readOnly: true
minLength: 1
L2VPNTermination:
required:
- l2vpn
- assigned_object_type
- assigned_object_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
l2vpn:
$ref: '#/definitions/NestedL2VPN'
assigned_object_type:
title: Assigned object type
type: string
assigned_object_id:
title: Assigned object id
type: integer
maximum: 9223372036854775807
minimum: 0
assigned_object:
title: Assigned object
type: object
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableL2VPNTermination:
required:
- l2vpn
- assigned_object_type
- assigned_object_id
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
l2vpn:
title: L2vpn
type: integer
assigned_object_type:
title: Assigned object type
type: string
assigned_object_id:
title: Assigned object id
type: integer
maximum: 9223372036854775807
minimum: 0
assigned_object:
title: Assigned object
type: object
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedRouteTarget:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Route target value (formatted in accordance with RFC 4360)
type: string
maxLength: 21
minLength: 1
L2VPN:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
identifier:
title: Identifier
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
type:
title: Type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- VPWS
- VPLS
- VXLAN
- VXLAN-EVPN
- MPLS EVPN
- PBB EVPN
- EPL
- EVPL
- Ethernet Private LAN
- Ethernet Virtual Private LAN
- Ethernet Private Tree
- Ethernet Virtual Private Tree
value:
type: string
enum:
- vpws
- vpls
- vxlan
- vxlan-evpn
- mpls-evpn
- pbb-evpn
- epl
- evpl
- ep-lan
- evp-lan
- ep-tree
- evp-tree
import_targets:
type: array
items:
$ref: '#/definitions/NestedRouteTarget'
uniqueItems: true
export_targets:
type: array
items:
$ref: '#/definitions/NestedRouteTarget'
uniqueItems: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tenant:
$ref: '#/definitions/NestedTenant'
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableL2VPN:
required:
- name
- slug
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
identifier:
title: Identifier
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
type:
title: Type
type: string
enum:
- vpws
- vpls
- vxlan
- vxlan-evpn
- mpls-evpn
- pbb-evpn
- epl
- evpl
- ep-lan
- evp-lan
- ep-tree
- evp-tree
import_targets:
type: array
items:
type: integer
uniqueItems: true
export_targets:
type: array
items:
type: integer
uniqueItems: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tenant:
title: Tenant
type: integer
x-nullable: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
Prefix:
required:
- prefix
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- IPv4
- IPv6
value:
type: integer
enum:
- 4
- 6
readOnly: true
prefix:
title: Prefix
description: IPv4 or IPv6 network with mask
type: string
site:
$ref: '#/definitions/NestedSite'
vrf:
$ref: '#/definitions/NestedVRF'
tenant:
$ref: '#/definitions/NestedTenant'
vlan:
$ref: '#/definitions/NestedVLAN'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Container
- Active
- Reserved
- Deprecated
value:
type: string
enum:
- container
- active
- reserved
- deprecated
role:
$ref: '#/definitions/NestedRole'
is_pool:
title: Is a pool
description: All IP addresses within this prefix are considered usable
type: boolean
mark_utilized:
title: Mark utilized
description: Treat as 100% utilized
type: boolean
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
children:
title: Children
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritablePrefix:
required:
- prefix
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
family:
title: Family
type: string
readOnly: true
prefix:
title: Prefix
description: IPv4 or IPv6 network with mask
type: string
site:
title: Site
type: integer
x-nullable: true
vrf:
title: VRF
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
vlan:
title: VLAN
type: integer
x-nullable: true
status:
title: Status
description: Operational status of this prefix
type: string
enum:
- container
- active
- reserved
- deprecated
role:
title: Role
description: The primary function of this prefix
type: integer
x-nullable: true
is_pool:
title: Is a pool
description: All IP addresses within this prefix are considered usable
type: boolean
mark_utilized:
title: Mark utilized
description: Treat as 100% utilized
type: boolean
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
children:
title: Children
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
AvailablePrefix:
type: object
properties:
family:
title: Family
type: integer
readOnly: true
prefix:
title: Prefix
type: string
readOnly: true
minLength: 1
vrf:
$ref: '#/definitions/NestedVRF'
PrefixLength:
required:
- prefix_length
type: object
properties:
prefix_length:
title: Prefix length
type: integer
RIR:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
is_private:
title: Private
description: IP space managed by this RIR is considered private
type: boolean
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
aggregate_count:
title: Aggregate count
type: integer
readOnly: true
Role:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
weight:
title: Weight
type: integer
maximum: 32767
minimum: 0
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
RouteTarget:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Route target value (formatted in accordance with RFC 4360)
type: string
maxLength: 21
minLength: 1
tenant:
$ref: '#/definitions/NestedTenant'
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableRouteTarget:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
description: Route target value (formatted in accordance with RFC 4360)
type: string
maxLength: 21
minLength: 1
tenant:
title: Tenant
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ServiceTemplate:
required:
- name
- ports
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
ports:
type: array
items:
title: Ports
type: integer
maximum: 65535
minimum: 1
protocol:
title: Protocol
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- TCP
- UDP
- SCTP
value:
type: string
enum:
- tcp
- udp
- sctp
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableServiceTemplate:
required:
- name
- ports
- protocol
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
ports:
type: array
items:
title: Ports
type: integer
maximum: 65535
minimum: 1
protocol:
title: Protocol
type: string
enum:
- tcp
- udp
- sctp
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedVirtualMachine:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 64
minLength: 1
x-nullable: true
Service:
required:
- name
- ports
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
$ref: '#/definitions/NestedDevice'
virtual_machine:
$ref: '#/definitions/NestedVirtualMachine'
name:
title: Name
type: string
maxLength: 100
minLength: 1
ports:
type: array
items:
title: Ports
type: integer
maximum: 65535
minimum: 1
protocol:
title: Protocol
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- TCP
- UDP
- SCTP
value:
type: string
enum:
- tcp
- udp
- sctp
ipaddresses:
type: array
items:
$ref: '#/definitions/NestedIPAddress'
uniqueItems: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableService:
required:
- name
- ports
- protocol
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
device:
title: Device
type: integer
x-nullable: true
virtual_machine:
title: Virtual machine
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
ports:
type: array
items:
title: Ports
type: integer
maximum: 65535
minimum: 1
protocol:
title: Protocol
type: string
enum:
- tcp
- udp
- sctp
ipaddresses:
description: The specific IP addresses (if any) to which this service is bound
type: array
items:
title: IP addresses
description: The specific IP addresses (if any) to which this service is
bound
type: integer
uniqueItems: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
VLANGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
scope_type:
title: Scope type
type: string
x-nullable: true
scope_id:
title: Scope id
type: integer
x-nullable: true
scope:
title: Scope
type: object
readOnly: true
min_vid:
title: Minimum VLAN ID
description: Lowest permissible ID of a child VLAN
type: integer
maximum: 4094
minimum: 1
max_vid:
title: Maximum VLAN ID
description: Highest permissible ID of a child VLAN
type: integer
maximum: 4094
minimum: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
NestedVLANGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
vlan_count:
title: Vlan count
type: integer
readOnly: true
AvailableVLAN:
type: object
properties:
vid:
title: Vid
type: integer
readOnly: true
group:
$ref: '#/definitions/NestedVLANGroup'
WritableCreateAvailableVLAN:
required:
- name
type: object
properties:
name:
title: Name
type: string
maxLength: 64
minLength: 1
site:
title: Site
description: The specific site to which this VLAN is assigned (if any)
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
status:
title: Status
description: Operational status of this VLAN
type: string
enum:
- active
- reserved
- deprecated
role:
title: Role
description: The primary function of this VLAN
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
VLAN:
required:
- vid
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
site:
$ref: '#/definitions/NestedSite'
group:
$ref: '#/definitions/NestedVLANGroup'
vid:
title: ID
description: Numeric VLAN ID (1-4094)
type: integer
maximum: 4094
minimum: 1
name:
title: Name
type: string
maxLength: 64
minLength: 1
tenant:
$ref: '#/definitions/NestedTenant'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Active
- Reserved
- Deprecated
value:
type: string
enum:
- active
- reserved
- deprecated
role:
$ref: '#/definitions/NestedRole'
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
l2vpn_termination:
$ref: '#/definitions/NestedL2VPNTermination'
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
WritableVLAN:
required:
- vid
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
site:
title: Site
description: The specific site to which this VLAN is assigned (if any)
type: integer
x-nullable: true
group:
title: Group
description: VLAN group (optional)
type: integer
x-nullable: true
vid:
title: ID
description: Numeric VLAN ID (1-4094)
type: integer
maximum: 4094
minimum: 1
name:
title: Name
type: string
maxLength: 64
minLength: 1
tenant:
title: Tenant
type: integer
x-nullable: true
status:
title: Status
description: Operational status of this VLAN
type: string
enum:
- active
- reserved
- deprecated
role:
title: Role
description: The primary function of this VLAN
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
l2vpn_termination:
title: L2vpn termination
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
VRF:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
rd:
title: Route distinguisher
description: Unique route distinguisher (as defined in RFC 4364)
type: string
maxLength: 21
x-nullable: true
tenant:
$ref: '#/definitions/NestedTenant'
enforce_unique:
title: Enforce unique space
description: Prevent duplicate prefixes/IP addresses within this VRF
type: boolean
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
import_targets:
type: array
items:
$ref: '#/definitions/NestedRouteTarget'
uniqueItems: true
export_targets:
type: array
items:
$ref: '#/definitions/NestedRouteTarget'
uniqueItems: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ipaddress_count:
title: Ipaddress count
type: integer
readOnly: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
WritableVRF:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
rd:
title: Route distinguisher
description: Unique route distinguisher (as defined in RFC 4364)
type: string
maxLength: 21
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
enforce_unique:
title: Enforce unique space
description: Prevent duplicate prefixes/IP addresses within this VRF
type: boolean
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
import_targets:
type: array
items:
type: integer
uniqueItems: true
export_targets:
type: array
items:
type: integer
uniqueItems: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
ipaddress_count:
title: Ipaddress count
type: integer
readOnly: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
NestedContact:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
NestedContactRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
x-nullable: true
ContactAssignment:
required:
- content_type
- object_id
- contact
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_type:
title: Content type
type: string
object_id:
title: Object id
type: integer
maximum: 9223372036854775807
minimum: 0
object:
title: Object
type: object
readOnly: true
contact:
$ref: '#/definitions/NestedContact'
role:
$ref: '#/definitions/NestedContactRole'
priority:
title: Priority
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Primary
- Secondary
- Tertiary
- Inactive
value:
type: string
enum:
- primary
- secondary
- tertiary
- inactive
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableContactAssignment:
required:
- content_type
- object_id
- contact
- role
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
content_type:
title: Content type
type: string
object_id:
title: Object id
type: integer
maximum: 9223372036854775807
minimum: 0
object:
title: Object
type: object
readOnly: true
contact:
title: Contact
type: integer
role:
title: Role
type: integer
priority:
title: Priority
type: string
enum:
- primary
- secondary
- tertiary
- inactive
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
NestedContactGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
contact_count:
title: Contact count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
x-nullable: true
ContactGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
$ref: '#/definitions/NestedContactGroup'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
contact_count:
title: Contact count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritableContactGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
title: Parent
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
contact_count:
title: Contact count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
ContactRole:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
Contact:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
group:
$ref: '#/definitions/NestedContactGroup'
name:
title: Name
type: string
maxLength: 100
minLength: 1
title:
title: Title
type: string
maxLength: 100
phone:
title: Phone
type: string
maxLength: 50
email:
title: Email
type: string
format: email
maxLength: 254
address:
title: Address
type: string
maxLength: 200
link:
title: Link
type: string
format: uri
maxLength: 200
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableContact:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
group:
title: Group
type: integer
x-nullable: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
title:
title: Title
type: string
maxLength: 100
phone:
title: Phone
type: string
maxLength: 50
email:
title: Email
type: string
format: email
maxLength: 254
address:
title: Address
type: string
maxLength: 200
link:
title: Link
type: string
format: uri
maxLength: 200
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
TenantGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
$ref: '#/definitions/NestedTenantGroup'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
tenant_count:
title: Tenant count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritableTenantGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
title: Parent
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
tenant_count:
title: Tenant count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
Tenant:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
group:
$ref: '#/definitions/NestedTenantGroup'
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default:
cust_id: null
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
device_count:
title: Device count
type: integer
readOnly: true
ipaddress_count:
title: Ipaddress count
type: integer
readOnly: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
rack_count:
title: Rack count
type: integer
readOnly: true
site_count:
title: Site count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
vrf_count:
title: Vrf count
type: integer
readOnly: true
cluster_count:
title: Cluster count
type: integer
readOnly: true
WritableTenant:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
group:
title: Group
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default:
cust_id: null
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
circuit_count:
title: Circuit count
type: integer
readOnly: true
device_count:
title: Device count
type: integer
readOnly: true
ipaddress_count:
title: Ipaddress count
type: integer
readOnly: true
prefix_count:
title: Prefix count
type: integer
readOnly: true
rack_count:
title: Rack count
type: integer
readOnly: true
site_count:
title: Site count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
vlan_count:
title: Vlan count
type: integer
readOnly: true
vrf_count:
title: Vrf count
type: integer
readOnly: true
cluster_count:
title: Cluster count
type: integer
readOnly: true
Group:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 150
minLength: 1
user_count:
title: User count
type: integer
readOnly: true
NestedGroup:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 150
minLength: 1
ObjectPermission:
required:
- name
- object_types
- actions
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
enabled:
title: Enabled
type: boolean
object_types:
type: array
items:
type: string
uniqueItems: true
groups:
type: array
items:
$ref: '#/definitions/NestedGroup'
uniqueItems: true
users:
type: array
items:
$ref: '#/definitions/NestedUser'
uniqueItems: true
actions:
description: The list of actions granted by this permission
type: array
items:
title: Actions
type: string
maxLength: 30
minLength: 1
constraints:
title: Constraints
description: Queryset filter matching the applicable objects of the selected
type(s)
type: object
x-nullable: true
WritableObjectPermission:
required:
- name
- object_types
- actions
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
enabled:
title: Enabled
type: boolean
object_types:
type: array
items:
type: string
uniqueItems: true
groups:
type: array
items:
type: integer
uniqueItems: true
users:
type: array
items:
type: integer
uniqueItems: true
actions:
description: The list of actions granted by this permission
type: array
items:
title: Actions
type: string
maxLength: 30
minLength: 1
constraints:
title: Constraints
description: Queryset filter matching the applicable objects of the selected
type(s)
type: object
x-nullable: true
IPNetwork:
type: object
properties: {}
Token:
required:
- user
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
user:
$ref: '#/definitions/NestedUser'
created:
title: Created
type: string
format: date-time
readOnly: true
expires:
title: Expires
type: string
format: date-time
x-nullable: true
last_used:
title: Last used
type: string
format: date-time
x-nullable: true
key:
title: Key
type: string
maxLength: 40
minLength: 40
write_enabled:
title: Write enabled
description: Permit create/update/delete operations using this key
type: boolean
description:
title: Description
type: string
maxLength: 200
allowed_ips:
type: array
items:
$ref: '#/definitions/IPNetwork'
default: []
WritableToken:
required:
- user
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
user:
title: User
type: integer
created:
title: Created
type: string
format: date-time
readOnly: true
expires:
title: Expires
type: string
format: date-time
x-nullable: true
last_used:
title: Last used
type: string
format: date-time
x-nullable: true
key:
title: Key
type: string
maxLength: 40
minLength: 40
write_enabled:
title: Write enabled
description: Permit create/update/delete operations using this key
type: boolean
description:
title: Description
type: string
maxLength: 200
allowed_ips:
type: array
items:
$ref: '#/definitions/IPNetwork'
default: []
User:
required:
- username
- password
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
username:
title: Username
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
type: string
pattern: ^[\w.@+-]+$
maxLength: 150
minLength: 1
password:
title: Password
type: string
maxLength: 128
minLength: 1
first_name:
title: First name
type: string
maxLength: 150
last_name:
title: Last name
type: string
maxLength: 150
email:
title: Email address
type: string
format: email
maxLength: 254
is_staff:
title: Staff status
description: Designates whether the user can log into this admin site.
type: boolean
is_active:
title: Active
description: Designates whether this user should be treated as active. Unselect
this instead of deleting accounts.
type: boolean
date_joined:
title: Date joined
type: string
format: date-time
groups:
type: array
items:
$ref: '#/definitions/NestedGroup'
uniqueItems: true
WritableUser:
required:
- username
- password
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
username:
title: Username
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
type: string
pattern: ^[\w.@+-]+$
maxLength: 150
minLength: 1
password:
title: Password
type: string
maxLength: 128
minLength: 1
first_name:
title: First name
type: string
maxLength: 150
last_name:
title: Last name
type: string
maxLength: 150
email:
title: Email address
type: string
format: email
maxLength: 254
is_staff:
title: Staff status
description: Designates whether the user can log into this admin site.
type: boolean
is_active:
title: Active
description: Designates whether this user should be treated as active. Unselect
this instead of deleting accounts.
type: boolean
date_joined:
title: Date joined
type: string
format: date-time
groups:
description: The groups this user belongs to. A user will get all permissions
granted to each of their groups.
type: array
items:
description: The groups this user belongs to. A user will get all permissions
granted to each of their groups.
type: integer
uniqueItems: true
ClusterGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
cluster_count:
title: Cluster count
type: integer
readOnly: true
ClusterType:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
cluster_count:
title: Cluster count
type: integer
readOnly: true
Cluster:
required:
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
type:
$ref: '#/definitions/NestedClusterType'
group:
$ref: '#/definitions/NestedClusterGroup'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Planned
- Staging
- Active
- Decommissioning
- Offline
value:
type: string
enum:
- planned
- staging
- active
- decommissioning
- offline
tenant:
$ref: '#/definitions/NestedTenant'
site:
$ref: '#/definitions/NestedSite'
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
WritableCluster:
required:
- name
- type
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
type:
title: Type
type: integer
group:
title: Group
type: integer
x-nullable: true
status:
title: Status
type: string
enum:
- planned
- staging
- active
- decommissioning
- offline
tenant:
title: Tenant
type: integer
x-nullable: true
site:
title: Site
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
device_count:
title: Device count
type: integer
readOnly: true
virtualmachine_count:
title: Virtualmachine count
type: integer
readOnly: true
NestedVMInterface:
required:
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
virtual_machine:
$ref: '#/definitions/NestedVirtualMachine'
name:
title: Name
type: string
maxLength: 64
minLength: 1
x-nullable: true
VMInterface:
required:
- virtual_machine
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
virtual_machine:
$ref: '#/definitions/NestedVirtualMachine'
name:
title: Name
type: string
maxLength: 64
minLength: 1
enabled:
title: Enabled
type: boolean
parent:
$ref: '#/definitions/NestedVMInterface'
bridge:
$ref: '#/definitions/NestedVMInterface'
mtu:
title: MTU
type: integer
maximum: 65536
minimum: 1
x-nullable: true
mac_address:
title: MAC Address
type: string
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mode:
title: Mode
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Access
- Tagged
- Tagged (All)
value:
type: string
enum:
- access
- tagged
- tagged-all
untagged_vlan:
$ref: '#/definitions/NestedVLAN'
tagged_vlans:
type: array
items:
$ref: '#/definitions/NestedVLAN'
uniqueItems: true
vrf:
$ref: '#/definitions/NestedVRF'
l2vpn_termination:
$ref: '#/definitions/NestedL2VPNTermination'
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
count_ipaddresses:
title: Count ipaddresses
type: integer
readOnly: true
count_fhrp_groups:
title: Count fhrp groups
type: integer
readOnly: true
WritableVMInterface:
required:
- virtual_machine
- name
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
virtual_machine:
title: Virtual machine
type: integer
name:
title: Name
type: string
maxLength: 64
minLength: 1
enabled:
title: Enabled
type: boolean
parent:
title: Parent interface
type: integer
x-nullable: true
bridge:
title: Bridge interface
type: integer
x-nullable: true
mtu:
title: MTU
type: integer
maximum: 65536
minimum: 1
x-nullable: true
mac_address:
title: MAC Address
type: string
x-nullable: true
description:
title: Description
type: string
maxLength: 200
mode:
title: Mode
description: IEEE 802.1Q tagging strategy
type: string
enum:
- access
- tagged
- tagged-all
untagged_vlan:
title: Untagged VLAN
type: integer
x-nullable: true
tagged_vlans:
type: array
items:
title: Tagged VLANs
type: integer
uniqueItems: true
vrf:
title: VRF
type: integer
x-nullable: true
l2vpn_termination:
title: L2vpn termination
type: string
readOnly: true
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
count_ipaddresses:
title: Count ipaddresses
type: integer
readOnly: true
count_fhrp_groups:
title: Count fhrp groups
type: integer
readOnly: true
NestedWirelessLANGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
wirelesslan_count:
title: Wirelesslan count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
x-nullable: true
WirelessLANGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
$ref: '#/definitions/NestedWirelessLANGroup'
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
wirelesslan_count:
title: Wirelesslan count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WritableWirelessLANGroup:
required:
- name
- slug
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
name:
title: Name
type: string
maxLength: 100
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 100
minLength: 1
parent:
title: Parent
type: integer
x-nullable: true
description:
title: Description
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
wirelesslan_count:
title: Wirelesslan count
type: integer
readOnly: true
_depth:
title: depth
type: integer
readOnly: true
WirelessLAN:
required:
- ssid
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
ssid:
title: SSID
type: string
maxLength: 32
minLength: 1
description:
title: Description
type: string
maxLength: 200
group:
$ref: '#/definitions/NestedWirelessLANGroup'
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Active
- Reserved
- Disabled
- Deprecated
value:
type: string
enum:
- active
- reserved
- disabled
- deprecated
vlan:
$ref: '#/definitions/NestedVLAN'
tenant:
$ref: '#/definitions/NestedTenant'
auth_type:
title: Auth type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Open
- WEP
- WPA Personal (PSK)
- WPA Enterprise
value:
type: string
enum:
- open
- wep
- wpa-personal
- wpa-enterprise
auth_cipher:
title: Auth cipher
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Auto
- TKIP
- AES
value:
type: string
enum:
- auto
- tkip
- aes
auth_psk:
title: Pre-shared key
type: string
maxLength: 64
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableWirelessLAN:
required:
- ssid
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
ssid:
title: SSID
type: string
maxLength: 32
minLength: 1
description:
title: Description
type: string
maxLength: 200
group:
title: Group
type: integer
x-nullable: true
status:
title: Status
type: string
enum:
- active
- reserved
- disabled
- deprecated
vlan:
title: VLAN
type: integer
x-nullable: true
tenant:
title: Tenant
type: integer
x-nullable: true
auth_type:
title: Auth Type
type: string
enum:
- open
- wep
- wpa-personal
- wpa-enterprise
auth_cipher:
title: Auth cipher
type: string
enum:
- auto
- tkip
- aes
auth_psk:
title: Pre-shared key
type: string
maxLength: 64
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WirelessLink:
required:
- interface_a
- interface_b
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
interface_a:
$ref: '#/definitions/NestedInterface'
interface_b:
$ref: '#/definitions/NestedInterface'
ssid:
title: SSID
type: string
maxLength: 32
status:
title: Status
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Connected
- Planned
- Decommissioning
value:
type: string
enum:
- connected
- planned
- decommissioning
tenant:
$ref: '#/definitions/NestedTenant'
auth_type:
title: Auth type
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Open
- WEP
- WPA Personal (PSK)
- WPA Enterprise
value:
type: string
enum:
- open
- wep
- wpa-personal
- wpa-enterprise
auth_cipher:
title: Auth cipher
required:
- label
- value
type: object
properties:
label:
type: string
enum:
- Auto
- TKIP
- AES
value:
type: string
enum:
- auto
- tkip
- aes
auth_psk:
title: Pre-shared key
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true
WritableWirelessLink:
required:
- interface_a
- interface_b
type: object
properties:
id:
title: ID
type: integer
readOnly: true
url:
title: Url
type: string
format: uri
readOnly: true
display:
title: Display
type: string
readOnly: true
interface_a:
title: Interface A
type: integer
interface_b:
title: Interface B
type: integer
ssid:
title: SSID
type: string
maxLength: 32
status:
title: Status
type: string
enum:
- connected
- planned
- decommissioning
tenant:
title: Tenant
type: integer
x-nullable: true
auth_type:
title: Auth Type
type: string
enum:
- open
- wep
- wpa-personal
- wpa-enterprise
auth_cipher:
title: Auth cipher
type: string
enum:
- auto
- tkip
- aes
auth_psk:
title: Pre-shared key
type: string
maxLength: 64
description:
title: Description
type: string
maxLength: 200
comments:
title: Comments
type: string
tags:
type: array
items:
$ref: '#/definitions/NestedTag'
custom_fields:
title: Custom fields
type: object
default: {}
created:
title: Created
type: string
format: date-time
readOnly: true
x-nullable: true
last_updated:
title: Last updated
type: string
format: date-time
readOnly: true
x-nullable: true