96012 lines
2.3 MiB
96012 lines
2.3 MiB
openapi: 3.0.3
|
|
info:
|
|
title: API Documentation
|
|
version: 1.3.2 (1.3)
|
|
description: Source of truth and network automation platform
|
|
license:
|
|
name: Apache v2 License
|
|
paths:
|
|
/circuits/circuit-terminations/:
|
|
get:
|
|
operationId: circuits_circuit_terminations_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: circuit_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Circuit
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: circuit_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Circuit
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: port_speed
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: port_speed__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: port_speed__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: port_speed__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: port_speed__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: port_speed__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_network_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Provider Network (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_network_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Provider Network (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: term_side
|
|
schema:
|
|
type: string
|
|
title: Termination
|
|
- in: query
|
|
name: term_side__n
|
|
schema:
|
|
type: string
|
|
title: Termination
|
|
- in: query
|
|
name: upstream_speed
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: upstream_speed__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: upstream_speed__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: upstream_speed__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: upstream_speed__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: upstream_speed__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: xconnect_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCircuitTerminationList'
|
|
description: ''
|
|
post:
|
|
operationId: circuits_circuit_terminations_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_circuit_terminations_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_circuit_terminations_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuitTermination'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuitTermination'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuitTermination'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_circuit_terminations_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/circuit-terminations/{id}/:
|
|
get:
|
|
operationId: circuits_circuit_terminations_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit termination.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_circuit_terminations_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit termination.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuitTermination'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_circuit_terminations_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit termination.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuitTermination'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuitTermination'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuitTermination'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_circuit_terminations_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit termination.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/circuit-terminations/{id}/trace/:
|
|
get:
|
|
operationId: circuits_circuit_terminations_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit termination.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
description: ''
|
|
/circuits/circuit-types/:
|
|
get:
|
|
operationId: circuits_circuit_types_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCircuitTypeList'
|
|
description: ''
|
|
post:
|
|
operationId: circuits_circuit_types_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_circuit_types_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_circuit_types_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitType'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_circuit_types_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/circuit-types/{id}/:
|
|
get:
|
|
operationId: circuits_circuit_types_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit type.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_circuit_types_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit type.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_circuit_types_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit type.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitType'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_circuit_types_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit type.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/circuits/:
|
|
get:
|
|
operationId: circuits_circuits_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: cid
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cid__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: commit_rate
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: commit_rate__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: commit_rate__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: commit_rate__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: commit_rate__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: commit_rate__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: install_date
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: install_date__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: install_date__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: install_date__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: install_date__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: install_date__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: provider
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Provider (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Provider (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Provider (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Provider (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_network_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Provider Network (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_network_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Provider Network (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Circuit type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Circuit type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Circuit type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Circuit type (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCircuitList'
|
|
description: ''
|
|
post:
|
|
operationId: circuits_circuits_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Circuit'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_circuits_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Circuit'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_circuits_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuit'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuit'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuit'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Circuit'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_circuits_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/circuits/{id}/:
|
|
get:
|
|
operationId: circuits_circuits_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Circuit'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_circuits_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCircuit'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Circuit'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_circuits_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuit'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuit'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCircuit'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Circuit'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_circuits_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/provider-networks/:
|
|
get:
|
|
operationId: circuits_provider_networks_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: provider
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Provider (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Provider (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Provider (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Provider (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedProviderNetworkList'
|
|
description: ''
|
|
post:
|
|
operationId: circuits_provider_networks_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_provider_networks_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_provider_networks_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableProviderNetwork'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableProviderNetwork'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableProviderNetwork'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_provider_networks_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/provider-networks/{id}/:
|
|
get:
|
|
operationId: circuits_provider_networks_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider network.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_provider_networks_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider network.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableProviderNetwork'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_provider_networks_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider network.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableProviderNetwork'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableProviderNetwork'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableProviderNetwork'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_provider_networks_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider network.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/providers/:
|
|
get:
|
|
operationId: circuits_providers_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: account
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: account__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedProviderList'
|
|
description: ''
|
|
post:
|
|
operationId: circuits_providers_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_providers_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_providers_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProvider'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProvider'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProvider'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_providers_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/circuits/providers/{id}/:
|
|
get:
|
|
operationId: circuits_providers_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
description: ''
|
|
put:
|
|
operationId: circuits_providers_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
description: ''
|
|
patch:
|
|
operationId: circuits_providers_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProvider'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProvider'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProvider'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Provider'
|
|
description: ''
|
|
delete:
|
|
operationId: circuits_providers_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this provider.
|
|
required: true
|
|
tags:
|
|
- circuits
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/cables/:
|
|
get:
|
|
operationId: dcim_cables_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: color
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: label__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: length
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: length__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: length__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: length__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: length__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: length__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: length_unit
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: length_unit__n
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCableList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_cables_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cable'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_cables_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cable'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_cables_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCable'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCable'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCable'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cable'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_cables_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/cables/{id}/:
|
|
get:
|
|
operationId: dcim_cables_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cable.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cable'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_cables_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cable.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCable'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cable'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_cables_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cable.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCable'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCable'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCable'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cable'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_cables_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cable.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/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:
|
|
- in: query
|
|
name: peer_device
|
|
schema:
|
|
type: string
|
|
description: The name of the peer device
|
|
required: true
|
|
- in: query
|
|
name: peer_interface
|
|
schema:
|
|
type: string
|
|
description: The name of the peer interface
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Device'
|
|
description: ''
|
|
/dcim/console-connections/:
|
|
get:
|
|
operationId: dcim_console_connections_list
|
|
parameters:
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: string
|
|
description: Site (slug)
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConsolePortList'
|
|
description: ''
|
|
/dcim/console-port-templates/:
|
|
get:
|
|
operationId: dcim_console_port_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConsolePortTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_console_port_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_port_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_port_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_port_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-port-templates/{id}/:
|
|
get:
|
|
operationId: dcim_console_port_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_port_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_port_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_port_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-ports/:
|
|
get:
|
|
operationId: dcim_console_ports_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConsolePortList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_console_ports_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_ports_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_ports_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_ports_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-ports/{id}/:
|
|
get:
|
|
operationId: dcim_console_ports_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_ports_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsolePort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_ports_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsolePort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_ports_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-ports/{id}/trace/:
|
|
get:
|
|
operationId: dcim_console_ports_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
description: ''
|
|
/dcim/console-server-port-templates/:
|
|
get:
|
|
operationId: dcim_console_server_port_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConsoleServerPortTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_console_server_port_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_server_port_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_server_port_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_server_port_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-server-port-templates/{id}/:
|
|
get:
|
|
operationId: dcim_console_server_port_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_server_port_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_server_port_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_server_port_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-server-ports/:
|
|
get:
|
|
operationId: dcim_console_server_ports_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConsoleServerPortList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_console_server_ports_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_server_ports_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_server_ports_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_server_ports_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-server-ports/{id}/:
|
|
get:
|
|
operationId: dcim_console_server_ports_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_console_server_ports_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConsoleServerPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_console_server_ports_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConsoleServerPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_console_server_ports_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/console-server-ports/{id}/trace/:
|
|
get:
|
|
operationId: dcim_console_server_ports_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this console server port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
description: ''
|
|
/dcim/device-bay-templates/:
|
|
get:
|
|
operationId: dcim_device_bay_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDeviceBayTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_device_bay_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_bay_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_bay_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_bay_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-bay-templates/{id}/:
|
|
get:
|
|
operationId: dcim_device_bay_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_bay_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBayTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_bay_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_bay_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-bays/:
|
|
get:
|
|
operationId: dcim_device_bays_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDeviceBayList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_device_bays_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_bays_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_bays_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBay'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBay'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBay'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_bays_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-bays/{id}/:
|
|
get:
|
|
operationId: dcim_device_bays_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_bays_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceBay'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_bays_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBay'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBay'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceBay'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_bays_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device bay.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-roles/:
|
|
get:
|
|
operationId: dcim_device_roles_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: color
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vm_role
|
|
schema:
|
|
type: boolean
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDeviceRoleList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_device_roles_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_roles_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_roles_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDeviceRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDeviceRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDeviceRole'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_roles_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-roles/{id}/:
|
|
get:
|
|
operationId: dcim_device_roles_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_roles_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_roles_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDeviceRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDeviceRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDeviceRole'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_roles_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-types/:
|
|
get:
|
|
operationId: dcim_device_types_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: console_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has console ports
|
|
- in: query
|
|
name: console_server_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has console server ports
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: device_bays
|
|
schema:
|
|
type: boolean
|
|
description: Has device bays
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: interfaces
|
|
schema:
|
|
type: boolean
|
|
description: Has interfaces
|
|
- in: query
|
|
name: is_full_depth
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: manufacturer
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: part_number
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_number__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: pass_through_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has pass-through ports
|
|
- in: query
|
|
name: power_outlets
|
|
schema:
|
|
type: boolean
|
|
description: Has power outlets
|
|
- in: query
|
|
name: power_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has power ports
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: subdevice_role
|
|
schema:
|
|
type: string
|
|
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.
|
|
- in: query
|
|
name: subdevice_role__n
|
|
schema:
|
|
type: string
|
|
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.
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDeviceTypeList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_device_types_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_types_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_types_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceType'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_types_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/device-types/{id}/:
|
|
get:
|
|
operationId: dcim_device_types_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device type.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_device_types_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device type.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_device_types_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device type.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceType'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_device_types_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device type.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/devices/:
|
|
get:
|
|
operationId: dcim_devices_list
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: query
|
|
name: asset_tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VM cluster (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VM cluster (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: console_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has console ports
|
|
- in: query
|
|
name: console_server_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has console server ports
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: device_bays
|
|
schema:
|
|
type: boolean
|
|
description: Has device bays
|
|
- in: query
|
|
name: device_type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: face
|
|
schema:
|
|
type: string
|
|
title: Rack face
|
|
- in: query
|
|
name: face__n
|
|
schema:
|
|
type: string
|
|
title: Rack face
|
|
- in: query
|
|
name: has_console_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has console ports
|
|
- in: query
|
|
name: has_console_server_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has console server ports
|
|
- in: query
|
|
name: has_device_bays
|
|
schema:
|
|
type: boolean
|
|
description: Has device bays
|
|
- in: query
|
|
name: has_front_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has front ports
|
|
- in: query
|
|
name: has_interfaces
|
|
schema:
|
|
type: boolean
|
|
description: Has interfaces
|
|
- in: query
|
|
name: has_power_outlets
|
|
schema:
|
|
type: boolean
|
|
description: Has power outlets
|
|
- in: query
|
|
name: has_power_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has power ports
|
|
- in: query
|
|
name: has_primary_ip
|
|
schema:
|
|
type: boolean
|
|
description: Has a primary IP
|
|
- in: query
|
|
name: has_rear_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has rear ports
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: interfaces
|
|
schema:
|
|
type: boolean
|
|
description: Has interfaces
|
|
- in: query
|
|
name: is_full_depth
|
|
schema:
|
|
type: boolean
|
|
description: Is full depth
|
|
- in: query
|
|
name: is_virtual_chassis_member
|
|
schema:
|
|
type: boolean
|
|
description: Is a virtual chassis member
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: local_context_data
|
|
schema:
|
|
type: boolean
|
|
description: Has local config context data
|
|
- in: query
|
|
name: local_context_schema
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Schema (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: local_context_schema__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Schema (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: local_context_schema_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Schema (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: local_context_schema_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Schema (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device model (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: model__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device model (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: pass_through_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has pass-through ports
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: position
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: position__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: position__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: position__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: position__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: position__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: power_outlets
|
|
schema:
|
|
type: boolean
|
|
description: Has power outlets
|
|
- in: query
|
|
name: power_ports
|
|
schema:
|
|
type: boolean
|
|
description: Has power ports
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Secrets group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Secrets group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Secrets group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Secrets group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: serial
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_position
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_position__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_position__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_position__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_position__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_position__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_priority
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_priority__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_priority__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_priority__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_priority__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vc_priority__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_chassis_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Virtual chassis (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_chassis_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Virtual chassis (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_chassis_member
|
|
schema:
|
|
type: boolean
|
|
description: Is a virtual chassis member
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDeviceWithConfigContextList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_devices_create
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_devices_bulk_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_devices_bulk_partial_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_devices_bulk_destroy
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/devices/{id}/:
|
|
get:
|
|
operationId: dcim_devices_retrieve
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_devices_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_devices_partial_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_devices_destroy
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/devices/{id}/napalm/:
|
|
get:
|
|
operationId: dcim_devices_napalm_retrieve
|
|
description: Execute a NAPALM method on a Device
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this device.
|
|
required: true
|
|
- in: query
|
|
name: method
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DeviceNAPALM'
|
|
description: ''
|
|
/dcim/front-port-templates/:
|
|
get:
|
|
operationId: dcim_front_port_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedFrontPortTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_front_port_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_front_port_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_front_port_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_front_port_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/front-port-templates/{id}/:
|
|
get:
|
|
operationId: dcim_front_port_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_front_port_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_front_port_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_front_port_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/front-ports/:
|
|
get:
|
|
operationId: dcim_front_ports_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedFrontPortList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_front_ports_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_front_ports_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_front_ports_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_front_ports_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/front-ports/{id}/:
|
|
get:
|
|
operationId: dcim_front_ports_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_front_ports_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableFrontPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_front_ports_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableFrontPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_front_ports_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/front-ports/{id}/paths/:
|
|
get:
|
|
operationId: dcim_front_ports_paths_retrieve
|
|
description: Return all CablePaths which traverse a given pass-through port.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this front port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
description: ''
|
|
/dcim/interface-connections/:
|
|
get:
|
|
operationId: dcim_interface_connections_list
|
|
parameters:
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: string
|
|
description: Site (slug)
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedInterfaceConnectionList'
|
|
description: ''
|
|
/dcim/interface-templates/:
|
|
get:
|
|
operationId: dcim_interface_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: mgmt_only
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedInterfaceTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_interface_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_interface_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_interface_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_interface_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/interface-templates/{id}/:
|
|
get:
|
|
operationId: dcim_interface_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_interface_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterfaceTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_interface_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_interface_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/interfaces/:
|
|
get:
|
|
operationId: dcim_interfaces_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: kind
|
|
schema:
|
|
type: string
|
|
description: Kind of interface
|
|
- in: query
|
|
name: lag_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: LAG interface (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: lag_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: LAG interface (ID)
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: mac_address
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mgmt_only
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: mode
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: mode__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: mtu
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vlan
|
|
schema:
|
|
type: number
|
|
description: Assigned VID
|
|
- in: query
|
|
name: vlan_id
|
|
schema:
|
|
type: string
|
|
description: Assigned VLAN
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedInterfaceList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_interfaces_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_interfaces_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_interfaces_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterface'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_interfaces_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/interfaces/{id}/:
|
|
get:
|
|
operationId: dcim_interfaces_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_interfaces_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInterface'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_interfaces_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInterface'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_interfaces_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/interfaces/{id}/trace/:
|
|
get:
|
|
operationId: dcim_interfaces_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this interface.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Interface'
|
|
description: ''
|
|
/dcim/inventory-items/:
|
|
get:
|
|
operationId: dcim_inventory_items_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: asset_tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: Device (name)
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: Device (name)
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
- in: query
|
|
name: discovered
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: manufacturer
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: parent_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Parent inventory item (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Parent inventory item (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: part_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: serial
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedInventoryItemList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_inventory_items_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_inventory_items_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_inventory_items_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInventoryItem'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInventoryItem'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInventoryItem'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_inventory_items_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/inventory-items/{id}/:
|
|
get:
|
|
operationId: dcim_inventory_items_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this inventory item.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_inventory_items_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this inventory item.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableInventoryItem'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_inventory_items_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this inventory item.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInventoryItem'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInventoryItem'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableInventoryItem'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_inventory_items_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this inventory item.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/manufacturers/:
|
|
get:
|
|
operationId: dcim_manufacturers_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedManufacturerList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_manufacturers_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_manufacturers_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_manufacturers_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedManufacturer'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedManufacturer'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedManufacturer'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_manufacturers_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/manufacturers/{id}/:
|
|
get:
|
|
operationId: dcim_manufacturers_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this manufacturer.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_manufacturers_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this manufacturer.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_manufacturers_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this manufacturer.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedManufacturer'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedManufacturer'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedManufacturer'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_manufacturers_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this manufacturer.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/platforms/:
|
|
get:
|
|
operationId: dcim_platforms_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: manufacturer
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: napalm_driver__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPlatformList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_platforms_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Platform'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_platforms_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Platform'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_platforms_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePlatform'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePlatform'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePlatform'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Platform'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_platforms_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/platforms/{id}/:
|
|
get:
|
|
operationId: dcim_platforms_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this platform.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Platform'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_platforms_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this platform.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePlatform'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Platform'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_platforms_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this platform.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePlatform'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePlatform'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePlatform'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Platform'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_platforms_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this platform.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-connections/:
|
|
get:
|
|
operationId: dcim_power_connections_list
|
|
parameters:
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: string
|
|
description: Site (slug)
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerPortList'
|
|
description: ''
|
|
/dcim/power-feeds/:
|
|
get:
|
|
operationId: dcim_power_feeds_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: amperage
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: amperage__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: amperage__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: amperage__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: amperage__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: amperage__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: max_utilization
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max_utilization__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max_utilization__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max_utilization__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max_utilization__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max_utilization__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: phase
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: phase__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: power_panel_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Power panel (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: power_panel_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Power panel (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: supply
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: supply__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: voltage
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: voltage__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: voltage__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: voltage__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: voltage__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: voltage__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerFeedList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_power_feeds_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_feeds_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_feeds_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerFeed'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerFeed'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerFeed'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_feeds_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-feeds/{id}/:
|
|
get:
|
|
operationId: dcim_power_feeds_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power feed.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_feeds_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power feed.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerFeed'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_feeds_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power feed.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerFeed'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerFeed'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerFeed'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_feeds_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power feed.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-feeds/{id}/trace/:
|
|
get:
|
|
operationId: dcim_power_feeds_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power feed.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
description: ''
|
|
/dcim/power-outlet-templates/:
|
|
get:
|
|
operationId: dcim_power_outlet_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: feed_leg
|
|
schema:
|
|
type: string
|
|
description: Phase (for three-phase feeds)
|
|
- in: query
|
|
name: feed_leg__n
|
|
schema:
|
|
type: string
|
|
description: Phase (for three-phase feeds)
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerOutletTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_power_outlet_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_outlet_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_outlet_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_outlet_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-outlet-templates/{id}/:
|
|
get:
|
|
operationId: dcim_power_outlet_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_outlet_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutletTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_outlet_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_outlet_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-outlets/:
|
|
get:
|
|
operationId: dcim_power_outlets_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: feed_leg
|
|
schema:
|
|
type: string
|
|
description: Phase (for three-phase feeds)
|
|
- in: query
|
|
name: feed_leg__n
|
|
schema:
|
|
type: string
|
|
description: Phase (for three-phase feeds)
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerOutletList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_power_outlets_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_outlets_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_outlets_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutlet'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutlet'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutlet'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_outlets_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-outlets/{id}/:
|
|
get:
|
|
operationId: dcim_power_outlets_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_outlets_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerOutlet'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_outlets_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutlet'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutlet'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerOutlet'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_outlets_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-outlets/{id}/trace/:
|
|
get:
|
|
operationId: dcim_power_outlets_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power outlet.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
description: ''
|
|
/dcim/power-panels/:
|
|
get:
|
|
operationId: dcim_power_panels_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerPanelList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_power_panels_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_panels_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_panels_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPanel'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPanel'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPanel'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_panels_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-panels/{id}/:
|
|
get:
|
|
operationId: dcim_power_panels_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power panel.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_panels_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power panel.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPanel'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_panels_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power panel.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPanel'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPanel'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPanel'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_panels_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power panel.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-port-templates/:
|
|
get:
|
|
operationId: dcim_power_port_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: allocated_draw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: maximum_draw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerPortTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_power_port_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_port_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_port_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_port_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-port-templates/{id}/:
|
|
get:
|
|
operationId: dcim_power_port_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_port_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_port_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_port_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-ports/:
|
|
get:
|
|
operationId: dcim_power_ports_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: allocated_draw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: allocated_draw__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: connected
|
|
schema:
|
|
type: boolean
|
|
description: Connected status (bool)
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: maximum_draw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: maximum_draw__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Physical port type
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPowerPortList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_power_ports_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_ports_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_ports_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_ports_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-ports/{id}/:
|
|
get:
|
|
operationId: dcim_power_ports_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_power_ports_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePowerPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_power_ports_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePowerPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_power_ports_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/power-ports/{id}/trace/:
|
|
get:
|
|
operationId: dcim_power_ports_trace_retrieve
|
|
description: Trace a complete cable path and return each segment as a three-tuple
|
|
of (termination, cable, termination).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this power port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
description: ''
|
|
/dcim/rack-groups/:
|
|
get:
|
|
operationId: dcim_rack_groups_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: parent
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRackGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_rack_groups_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rack_groups_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rack_groups_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rack_groups_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rack-groups/{id}/:
|
|
get:
|
|
operationId: dcim_rack_groups_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack group.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rack_groups_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack group.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rack_groups_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack group.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rack_groups_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack group.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rack-reservations/:
|
|
get:
|
|
operationId: dcim_rack_reservations_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: User (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: User (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRackReservationList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_rack_reservations_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rack_reservations_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rack_reservations_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackReservation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackReservation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackReservation'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rack_reservations_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rack-reservations/{id}/:
|
|
get:
|
|
operationId: dcim_rack_reservations_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack reservation.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rack_reservations_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack reservation.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRackReservation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rack_reservations_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack reservation.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackReservation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackReservation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRackReservation'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rack_reservations_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack reservation.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rack-roles/:
|
|
get:
|
|
operationId: dcim_rack_roles_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: color
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRackRoleList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_rack_roles_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rack_roles_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rack_roles_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRackRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRackRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRackRole'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rack_roles_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rack-roles/{id}/:
|
|
get:
|
|
operationId: dcim_rack_roles_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rack_roles_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rack_roles_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRackRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRackRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRackRole'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RackRole'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rack_roles_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack role.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/racks/:
|
|
get:
|
|
operationId: dcim_racks_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: asset_tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: desc_units
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: facility_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: outer_depth
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_unit
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: outer_unit__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: outer_width
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: serial
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: width
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Rail-to-rail width
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: width__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Rail-to-rail width
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRackList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_racks_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Rack'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_racks_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Rack'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_racks_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRack'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRack'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRack'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Rack'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_racks_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/racks/{id}/:
|
|
get:
|
|
operationId: dcim_racks_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Rack'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_racks_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRack'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Rack'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_racks_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRack'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRack'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRack'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Rack'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_racks_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/racks/{id}/elevation/:
|
|
get:
|
|
operationId: dcim_racks_elevation_list
|
|
description: Rack elevation representing the list of rack units. Also supports
|
|
rendering the elevation as an SVG.
|
|
parameters:
|
|
- in: query
|
|
name: asset_tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asset_tag__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: desc_units
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: exclude
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: expand_devices
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- in: query
|
|
name: face
|
|
schema:
|
|
enum:
|
|
- front
|
|
- rear
|
|
type: string
|
|
default: front
|
|
minLength: 1
|
|
- in: query
|
|
name: facility_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rack.
|
|
required: true
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: include_images
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: legend_width
|
|
schema:
|
|
type: integer
|
|
default: 30
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: outer_depth
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_depth__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_unit
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: outer_unit__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: outer_width
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: outer_width__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
minLength: 1
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: render
|
|
schema:
|
|
enum:
|
|
- json
|
|
- svg
|
|
type: string
|
|
default: json
|
|
minLength: 1
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: serial
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: u_height__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: unit_height
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: unit_width
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: width
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Rail-to-rail width
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: width__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Rail-to-rail width
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRackUnitList'
|
|
description: ''
|
|
/dcim/rear-port-templates/:
|
|
get:
|
|
operationId: dcim_rear_port_templates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: devicetype_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devicetype_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: positions
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRearPortTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_rear_port_templates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rear_port_templates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rear_port_templates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rear_port_templates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rear-port-templates/{id}/:
|
|
get:
|
|
operationId: dcim_rear_port_templates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rear_port_templates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPortTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rear_port_templates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPortTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPortTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPortTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rear_port_templates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port template.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rear-ports/:
|
|
get:
|
|
operationId: dcim_rear_ports_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: cabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: positions
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: positions__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRearPortList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_rear_ports_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rear_ports_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rear_ports_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rear_ports_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rear-ports/{id}/:
|
|
get:
|
|
operationId: dcim_rear_ports_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_rear_ports_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRearPort'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_rear_ports_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPort'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPort'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRearPort'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_rear_ports_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/rear-ports/{id}/paths/:
|
|
get:
|
|
operationId: dcim_rear_ports_paths_retrieve
|
|
description: Return all CablePaths which traverse a given pass-through port.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this rear port.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RearPort'
|
|
description: ''
|
|
/dcim/regions/:
|
|
get:
|
|
operationId: dcim_regions_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: parent
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Parent region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Parent region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Parent region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Parent region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRegionList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_regions_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Region'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_regions_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Region'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_regions_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRegion'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRegion'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRegion'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Region'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_regions_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/regions/{id}/:
|
|
get:
|
|
operationId: dcim_regions_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this region.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Region'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_regions_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this region.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRegion'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Region'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_regions_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this region.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRegion'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRegion'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRegion'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Region'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_regions_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this region.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/sites/:
|
|
get:
|
|
operationId: dcim_sites_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: asn
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: asn__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_email__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: contact_phone__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: facility
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: facility__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: latitude
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: latitude__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: latitude__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: latitude__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: latitude__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: latitude__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: longitude
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: longitude__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: longitude__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: longitude__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: longitude__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: longitude__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSiteList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_sites_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Site'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_sites_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Site'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_sites_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSite'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSite'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSite'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Site'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_sites_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/sites/{id}/:
|
|
get:
|
|
operationId: dcim_sites_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this site.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Site'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_sites_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this site.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSite'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Site'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_sites_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this site.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSite'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSite'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSite'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Site'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_sites_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this site.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/virtual-chassis/:
|
|
get:
|
|
operationId: dcim_virtual_chassis_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: domain
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: domain__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: master
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Master (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: master__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Master (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: master_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Master (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: master_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Master (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVirtualChassisList'
|
|
description: ''
|
|
post:
|
|
operationId: dcim_virtual_chassis_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_virtual_chassis_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_virtual_chassis_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualChassis'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualChassis'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualChassis'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_virtual_chassis_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/dcim/virtual-chassis/{id}/:
|
|
get:
|
|
operationId: dcim_virtual_chassis_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual chassis.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
description: ''
|
|
put:
|
|
operationId: dcim_virtual_chassis_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual chassis.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualChassis'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
description: ''
|
|
patch:
|
|
operationId: dcim_virtual_chassis_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual chassis.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualChassis'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualChassis'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualChassis'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
description: ''
|
|
delete:
|
|
operationId: dcim_virtual_chassis_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual chassis.
|
|
required: true
|
|
tags:
|
|
- dcim
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/computed-fields/:
|
|
get:
|
|
operationId: extras_computed_fields_list
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fallback_value
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fallback_value__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: template__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedComputedFieldList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_computed_fields_create
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
description: ''
|
|
put:
|
|
operationId: extras_computed_fields_bulk_update
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_computed_fields_bulk_partial_update
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComputedField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComputedField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComputedField'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_computed_fields_bulk_destroy
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/computed-fields/{id}/:
|
|
get:
|
|
operationId: extras_computed_fields_retrieve
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this computed field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
description: ''
|
|
put:
|
|
operationId: extras_computed_fields_update
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this computed field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_computed_fields_partial_update
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this computed field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComputedField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComputedField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComputedField'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_computed_fields_destroy
|
|
description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this computed field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/config-context-schemas/:
|
|
get:
|
|
operationId: extras_config_context_schemas_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: owner_content_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: owner_content_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConfigContextSchemaList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_config_context_schemas_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
description: ''
|
|
put:
|
|
operationId: extras_config_context_schemas_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_config_context_schemas_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigContextSchema'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigContextSchema'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigContextSchema'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_config_context_schemas_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/config-context-schemas/{id}/:
|
|
get:
|
|
operationId: extras_config_context_schemas_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context schema.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
description: ''
|
|
put:
|
|
operationId: extras_config_context_schemas_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context schema.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_config_context_schemas_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context schema.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigContextSchema'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigContextSchema'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigContextSchema'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_config_context_schemas_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context schema.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/config-contexts/:
|
|
get:
|
|
operationId: extras_config_contexts_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: cluster_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: is_active
|
|
schema:
|
|
type: boolean
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: owner_content_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: owner_content_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: owner_object_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Role
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Role
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tag (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tag (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConfigContextList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_config_contexts_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
description: ''
|
|
put:
|
|
operationId: extras_config_contexts_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_config_contexts_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConfigContext'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_config_contexts_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/config-contexts/{id}/:
|
|
get:
|
|
operationId: extras_config_contexts_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
description: ''
|
|
put:
|
|
operationId: extras_config_contexts_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_config_contexts_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableConfigContext'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_config_contexts_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config context.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/content-types/:
|
|
get:
|
|
operationId: extras_content_types_list
|
|
description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent
|
|
to Nautobot objects.
|
|
parameters:
|
|
- in: query
|
|
name: app_label
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: model
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedContentTypeList'
|
|
description: ''
|
|
/extras/content-types/{id}/:
|
|
get:
|
|
operationId: extras_content_types_retrieve
|
|
description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent
|
|
to Nautobot objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this content type.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContentType'
|
|
description: ''
|
|
/extras/custom-field-choices/:
|
|
get:
|
|
operationId: extras_custom_field_choices_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: field
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: Slug
|
|
description: Field (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: Slug
|
|
description: Field (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Field
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Field
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: value
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: value__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCustomFieldChoiceList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_custom_field_choices_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
description: ''
|
|
put:
|
|
operationId: extras_custom_field_choices_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_custom_field_choices_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_custom_field_choices_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/custom-field-choices/{id}/:
|
|
get:
|
|
operationId: extras_custom_field_choices_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field choice.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
description: ''
|
|
put:
|
|
operationId: extras_custom_field_choices_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field choice.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomFieldChoice'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_custom_field_choices_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field choice.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_custom_field_choices_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field choice.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/custom-fields/:
|
|
get:
|
|
operationId: extras_custom_fields_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: content_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_types__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: filter_logic
|
|
schema:
|
|
type: string
|
|
description: Loose matches any instance of a given string; Exact matches the
|
|
entire field.
|
|
- in: query
|
|
name: filter_logic__n
|
|
schema:
|
|
type: string
|
|
description: Loose matches any instance of a given string; Exact matches the
|
|
entire field.
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: required
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: weight
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCustomFieldList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_custom_fields_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomField'
|
|
description: ''
|
|
put:
|
|
operationId: extras_custom_fields_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomField'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_custom_fields_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomField'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomField'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_custom_fields_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/custom-fields/{id}/:
|
|
get:
|
|
operationId: extras_custom_fields_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomField'
|
|
description: ''
|
|
put:
|
|
operationId: extras_custom_fields_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCustomField'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomField'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_custom_fields_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomField'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomField'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCustomField'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomField'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_custom_fields_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom field.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/custom-links/:
|
|
get:
|
|
operationId: extras_custom_links_list
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: query
|
|
name: button_class
|
|
schema:
|
|
type: string
|
|
description: The class of the first link in a group will be used for the dropdown
|
|
button
|
|
- in: query
|
|
name: button_class__n
|
|
schema:
|
|
type: string
|
|
description: The class of the first link in a group will be used for the dropdown
|
|
button
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: group_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: new_window
|
|
schema:
|
|
type: boolean
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: target_url
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: target_url__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: text__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: weight__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCustomLinkList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_custom_links_create
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
description: ''
|
|
put:
|
|
operationId: extras_custom_links_bulk_update
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_custom_links_bulk_partial_update
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCustomLink'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCustomLink'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCustomLink'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_custom_links_bulk_destroy
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/custom-links/{id}/:
|
|
get:
|
|
operationId: extras_custom_links_retrieve
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom link.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
description: ''
|
|
put:
|
|
operationId: extras_custom_links_update
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom link.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_custom_links_partial_update
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom link.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCustomLink'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCustomLink'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCustomLink'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_custom_links_destroy
|
|
description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this custom link.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/dynamic-groups/:
|
|
get:
|
|
operationId: extras_dynamic_groups_list
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDynamicGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_dynamic_groups_create
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
put:
|
|
operationId: extras_dynamic_groups_bulk_update
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_dynamic_groups_bulk_partial_update
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDynamicGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDynamicGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDynamicGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_dynamic_groups_bulk_destroy
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/dynamic-groups/{id}/:
|
|
get:
|
|
operationId: extras_dynamic_groups_retrieve
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this dynamic group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
put:
|
|
operationId: extras_dynamic_groups_update
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this dynamic group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_dynamic_groups_partial_update
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this dynamic group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDynamicGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDynamicGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDynamicGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_dynamic_groups_destroy
|
|
description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this dynamic group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/dynamic-groups/{id}/members/:
|
|
get:
|
|
operationId: extras_dynamic_groups_members_retrieve
|
|
description: List member objects of the same type as the `content_type` for
|
|
this dynamic group.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this dynamic group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
description: ''
|
|
/extras/export-templates/:
|
|
get:
|
|
operationId: extras_export_templates_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: owner_content_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: owner_content_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: owner_object_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: owner_object_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedExportTemplateList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_export_templates_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: extras_export_templates_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_export_templates_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedExportTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedExportTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedExportTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_export_templates_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/export-templates/{id}/:
|
|
get:
|
|
operationId: extras_export_templates_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this export template.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
description: ''
|
|
put:
|
|
operationId: extras_export_templates_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this export template.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_export_templates_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this export template.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedExportTemplate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedExportTemplate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedExportTemplate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_export_templates_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this export template.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/git-repositories/:
|
|
get:
|
|
operationId: extras_git_repositories_list
|
|
description: Manage the use of Git repositories as external data sources.
|
|
parameters:
|
|
- in: query
|
|
name: branch
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: branch__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: remote_url
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: remote_url__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Secrets group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Secrets group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Secrets group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secrets_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Secrets group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedGitRepositoryList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_git_repositories_create
|
|
description: Manage the use of Git repositories as external data sources.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
put:
|
|
operationId: extras_git_repositories_bulk_update
|
|
description: Manage the use of Git repositories as external data sources.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_git_repositories_bulk_partial_update
|
|
description: Manage the use of Git repositories as external data sources.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableGitRepository'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableGitRepository'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableGitRepository'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_git_repositories_bulk_destroy
|
|
description: Manage the use of Git repositories as external data sources.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/git-repositories/{id}/:
|
|
get:
|
|
operationId: extras_git_repositories_retrieve
|
|
description: Manage the use of Git repositories as external data sources.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Git repository.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
put:
|
|
operationId: extras_git_repositories_update
|
|
description: Manage the use of Git repositories as external data sources.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Git repository.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableGitRepository'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_git_repositories_partial_update
|
|
description: Manage the use of Git repositories as external data sources.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Git repository.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableGitRepository'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableGitRepository'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableGitRepository'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_git_repositories_destroy
|
|
description: Manage the use of Git repositories as external data sources.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Git repository.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/git-repositories/{id}/sync/:
|
|
post:
|
|
operationId: extras_git_repositories_sync_create
|
|
description: Enqueue pull git repository and refresh data.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Git repository.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
description: ''
|
|
/extras/graphql-queries/:
|
|
get:
|
|
operationId: extras_graphql_queries_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedGraphQLQueryList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_graphql_queries_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
description: ''
|
|
put:
|
|
operationId: extras_graphql_queries_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_graphql_queries_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGraphQLQuery'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGraphQLQuery'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGraphQLQuery'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_graphql_queries_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/graphql-queries/{id}/:
|
|
get:
|
|
operationId: extras_graphql_queries_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this GraphQL query.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
description: ''
|
|
put:
|
|
operationId: extras_graphql_queries_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this GraphQL query.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_graphql_queries_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this GraphQL query.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGraphQLQuery'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGraphQLQuery'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGraphQLQuery'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_graphql_queries_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this GraphQL query.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/graphql-queries/{id}/run/:
|
|
post:
|
|
operationId: extras_graphql_queries_run_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this GraphQL query.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQueryInput'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQueryInput'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQueryInput'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLQueryOutput'
|
|
description: ''
|
|
/extras/image-attachments/:
|
|
get:
|
|
operationId: extras_image_attachments_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: content_type_id
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: content_type_id__n
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedImageAttachmentList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_image_attachments_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
description: ''
|
|
put:
|
|
operationId: extras_image_attachments_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_image_attachments_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedImageAttachment'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedImageAttachment'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedImageAttachment'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_image_attachments_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/image-attachments/{id}/:
|
|
get:
|
|
operationId: extras_image_attachments_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this image attachment.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
description: ''
|
|
put:
|
|
operationId: extras_image_attachments_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this image attachment.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_image_attachments_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this image attachment.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedImageAttachment'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedImageAttachment'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedImageAttachment'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_image_attachments_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this image attachment.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/job-logs/:
|
|
get:
|
|
operationId: extras_job_logs_list
|
|
description: Retrieve a list of job log entries.
|
|
parameters:
|
|
- in: query
|
|
name: absolute_url
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: absolute_url__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_result
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: job_result__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: log_level
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: log_level__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: log_object
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: log_object__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: message__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedJobLogEntryList'
|
|
description: ''
|
|
/extras/job-logs/{id}/:
|
|
get:
|
|
operationId: extras_job_logs_retrieve
|
|
description: Retrieve a list of job log entries.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job log entry.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobLogEntry'
|
|
description: ''
|
|
/extras/job-results/:
|
|
get:
|
|
operationId: extras_job_results_list
|
|
description: Retrieve a list of job results
|
|
parameters:
|
|
- in: query
|
|
name: completed
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Job (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Job (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Job (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Job (ID)
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: obj_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: obj_type__n
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: user__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedJobResultList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_job_results_create
|
|
description: Retrieve a list of job results
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
put:
|
|
operationId: extras_job_results_bulk_update
|
|
description: Retrieve a list of job results
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_job_results_bulk_partial_update
|
|
description: Retrieve a list of job results
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJobResult'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJobResult'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJobResult'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_job_results_bulk_destroy
|
|
description: Retrieve a list of job results
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/job-results/{id}/:
|
|
get:
|
|
operationId: extras_job_results_retrieve
|
|
description: Retrieve a list of job results
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job result.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
put:
|
|
operationId: extras_job_results_update
|
|
description: Retrieve a list of job results
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job result.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_job_results_partial_update
|
|
description: Retrieve a list of job results
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job result.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJobResult'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJobResult'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJobResult'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_job_results_destroy
|
|
description: Retrieve a list of job results
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job result.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/job-results/{id}/logs/:
|
|
get:
|
|
operationId: extras_job_results_logs_retrieve
|
|
description: Retrieve a list of job results
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job result.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
/extras/jobs/:
|
|
get:
|
|
operationId: extras_jobs_list
|
|
description: List all known Jobs.
|
|
parameters:
|
|
- in: query
|
|
name: approval_required
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: approval_required_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: commit_default
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: commit_default_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: description_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: grouping
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: grouping_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: hidden
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: hidden_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: installed
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: job_class_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_class_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: module_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: module_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name_override
|
|
schema:
|
|
type: boolean
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: read_only
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: read_only_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: soft_time_limit_override
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: source
|
|
schema:
|
|
type: string
|
|
description: Source of the Python code for this job - local, Git repository,
|
|
or plugins
|
|
- in: query
|
|
name: source__n
|
|
schema:
|
|
type: string
|
|
description: Source of the Python code for this job - local, Git repository,
|
|
or plugins
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time_limit_override
|
|
schema:
|
|
type: boolean
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedJobList'
|
|
description: ''
|
|
put:
|
|
operationId: extras_jobs_bulk_update
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_jobs_bulk_partial_update
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJob'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJob'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJob'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_jobs_bulk_destroy
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/jobs/{class_path}/:
|
|
get:
|
|
operationId: extras_jobs_read_deprecated
|
|
description: |-
|
|
Get details of a Job as identified by its class-path.
|
|
|
|
This API endpoint is deprecated; it is recommended to use the extras_jobs_read endpoint instead.
|
|
parameters:
|
|
- in: path
|
|
name: class_path
|
|
schema:
|
|
type: string
|
|
pattern: ^[^/]+/[^/]+/[^/]+$
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
deprecated: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobClassDetail'
|
|
description: ''
|
|
/extras/jobs/{class_path}/run/:
|
|
post:
|
|
operationId: extras_jobs_run_deprecated
|
|
description: |-
|
|
Run a Job as identified by its class-path.
|
|
|
|
This API endpoint is deprecated; it is recommended to use the extras_jobs_run endpoint instead.
|
|
parameters:
|
|
- in: path
|
|
name: class_path
|
|
schema:
|
|
type: string
|
|
pattern: ^[^/]+/[^/]+/[^/]+$
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/JobInput'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/JobInput'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/JobInput'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
deprecated: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobClassDetail'
|
|
description: ''
|
|
/extras/jobs/{id}/:
|
|
get:
|
|
operationId: extras_jobs_retrieve
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
description: ''
|
|
put:
|
|
operationId: extras_jobs_update
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_jobs_partial_update
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJob'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJob'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedJob'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_jobs_destroy
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/jobs/{id}/run/:
|
|
post:
|
|
operationId: extras_jobs_run_create
|
|
description: Run the specified Job.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/JobInput'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/JobInput'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/JobInput'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobRunResponse'
|
|
description: ''
|
|
/extras/jobs/{id}/variables/:
|
|
get:
|
|
operationId: extras_jobs_variables_list
|
|
description: Get details of the input variables that may/must be specified to
|
|
run a particular Job.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this job.
|
|
required: true
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedJobVariableList'
|
|
description: ''
|
|
/extras/object-changes/:
|
|
get:
|
|
operationId: extras_object_changes_list
|
|
description: Retrieve a list of recent changes.
|
|
parameters:
|
|
- in: query
|
|
name: action
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: action__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: changed_object_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: changed_object_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: changed_object_type__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: changed_object_type_id
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: changed_object_type_id__n
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: object_repr
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_repr__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: request_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: request_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: time__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User name
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User name
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: User (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: User (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedObjectChangeList'
|
|
description: ''
|
|
/extras/object-changes/{id}/:
|
|
get:
|
|
operationId: extras_object_changes_retrieve
|
|
description: Retrieve a list of recent changes.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this object change.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectChange'
|
|
description: ''
|
|
/extras/relationship-associations/:
|
|
get:
|
|
operationId: extras_relationship_associations_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: destination_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: relationship
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Relationship (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: relationship__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Relationship (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRelationshipAssociationList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_relationship_associations_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
description: ''
|
|
put:
|
|
operationId: extras_relationship_associations_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_relationship_associations_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_relationship_associations_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/relationship-associations/{id}/:
|
|
get:
|
|
operationId: extras_relationship_associations_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
description: ''
|
|
put:
|
|
operationId: extras_relationship_associations_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRelationshipAssociation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_relationship_associations_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_relationship_associations_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/relationships/:
|
|
get:
|
|
operationId: extras_relationships_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: destination_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: destination_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: source_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: source_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
description: Cardinality of this relationship
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: string
|
|
description: Cardinality of this relationship
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRelationshipList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_relationships_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
description: ''
|
|
put:
|
|
operationId: extras_relationships_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_relationships_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRelationship'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRelationship'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRelationship'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_relationships_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/relationships/{id}/:
|
|
get:
|
|
operationId: extras_relationships_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
description: ''
|
|
put:
|
|
operationId: extras_relationships_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_relationships_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRelationship'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRelationship'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRelationship'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Relationship'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_relationships_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this relationship.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/scheduled-jobs/:
|
|
get:
|
|
operationId: extras_scheduled_jobs_list
|
|
description: Retrieve a list of scheduled jobs
|
|
parameters:
|
|
- in: query
|
|
name: first_run
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Job (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Job (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Job (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: job_model_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Job (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_run
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: total_run_count
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: total_run_count__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: total_run_count__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: total_run_count__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: total_run_count__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: total_run_count__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedScheduledJobList'
|
|
description: ''
|
|
/extras/scheduled-jobs/{id}/:
|
|
get:
|
|
operationId: extras_scheduled_jobs_retrieve
|
|
description: Retrieve a list of scheduled jobs
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this scheduled job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ScheduledJob'
|
|
description: ''
|
|
/extras/scheduled-jobs/{id}/approve/:
|
|
post:
|
|
operationId: extras_scheduled_jobs_approve_create
|
|
description: Retrieve a list of scheduled jobs
|
|
parameters:
|
|
- in: query
|
|
name: force
|
|
schema:
|
|
type: boolean
|
|
description: force execution even if start time has passed
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this scheduled job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ScheduledJob'
|
|
description: ''
|
|
/extras/scheduled-jobs/{id}/deny/:
|
|
post:
|
|
operationId: extras_scheduled_jobs_deny_create
|
|
description: Retrieve a list of scheduled jobs
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this scheduled job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ScheduledJob'
|
|
description: ''
|
|
/extras/scheduled-jobs/{id}/dry-run/:
|
|
post:
|
|
operationId: extras_scheduled_jobs_dry_run_create
|
|
description: Retrieve a list of scheduled jobs
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this scheduled job.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/JobResult'
|
|
description: ''
|
|
/extras/secrets/:
|
|
get:
|
|
operationId: extras_secrets_list
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: provider
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: provider__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSecretList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_secrets_create
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
description: ''
|
|
put:
|
|
operationId: extras_secrets_bulk_update
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_secrets_bulk_partial_update
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecret'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecret'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecret'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_secrets_bulk_destroy
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/secrets-groups/:
|
|
get:
|
|
operationId: extras_secrets_groups_list
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSecretsGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_secrets_groups_create
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
description: ''
|
|
put:
|
|
operationId: extras_secrets_groups_bulk_update
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_secrets_groups_bulk_partial_update
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecretsGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecretsGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecretsGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_secrets_groups_bulk_destroy
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/secrets-groups-associations/:
|
|
get:
|
|
operationId: extras_secrets_groups_associations_list
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
parameters:
|
|
- in: query
|
|
name: access_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: access_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: secret
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Secret (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secret__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Secret (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secret_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Secret (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secret_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Secret (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secret_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: secret_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSecretsGroupAssociationList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_secrets_groups_associations_create
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
description: ''
|
|
put:
|
|
operationId: extras_secrets_groups_associations_bulk_update
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_secrets_groups_associations_bulk_partial_update
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_secrets_groups_associations_bulk_destroy
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/secrets-groups-associations/{id}/:
|
|
get:
|
|
operationId: extras_secrets_groups_associations_retrieve
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
description: ''
|
|
put:
|
|
operationId: extras_secrets_groups_associations_update
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSecretsGroupAssociation'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_secrets_groups_associations_partial_update
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_secrets_groups_associations_destroy
|
|
description: Manage Secrets Group Associations through DELETE, GET, POST, PUT,
|
|
and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group association.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/secrets-groups/{id}/:
|
|
get:
|
|
operationId: extras_secrets_groups_retrieve
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
description: ''
|
|
put:
|
|
operationId: extras_secrets_groups_update
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_secrets_groups_partial_update
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecretsGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecretsGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecretsGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_secrets_groups_destroy
|
|
description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH
|
|
requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secrets group.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/secrets/{id}/:
|
|
get:
|
|
operationId: extras_secrets_retrieve
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secret.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
description: ''
|
|
put:
|
|
operationId: extras_secrets_update
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secret.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_secrets_partial_update
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secret.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecret'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecret'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSecret'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Secret'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_secrets_destroy
|
|
description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this secret.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/statuses/:
|
|
get:
|
|
operationId: extras_statuses_list
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
parameters:
|
|
- in: query
|
|
name: color
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_types__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedStatusList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_statuses_create
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
description: ''
|
|
put:
|
|
operationId: extras_statuses_bulk_update
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_statuses_bulk_partial_update
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStatus'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStatus'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStatus'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_statuses_bulk_destroy
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/statuses/{id}/:
|
|
get:
|
|
operationId: extras_statuses_retrieve
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this status.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
description: ''
|
|
put:
|
|
operationId: extras_statuses_update
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this status.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_statuses_partial_update
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this status.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStatus'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStatus'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStatus'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Status'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_statuses_destroy
|
|
description: View and manage custom status choices for objects with a `status`
|
|
field.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this status.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/tags/:
|
|
get:
|
|
operationId: extras_tags_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: color
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: color__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_types__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTagSerializerVersion13List'
|
|
description: ''
|
|
post:
|
|
operationId: extras_tags_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
description: ''
|
|
put:
|
|
operationId: extras_tags_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_tags_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTagSerializerVersion13'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTagSerializerVersion13'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTagSerializerVersion13'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_tags_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/tags/{id}/:
|
|
get:
|
|
operationId: extras_tags_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tag.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
description: ''
|
|
put:
|
|
operationId: extras_tags_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tag.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_tags_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tag.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTagSerializerVersion13'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTagSerializerVersion13'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTagSerializerVersion13'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_tags_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tag.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/webhooks/:
|
|
get:
|
|
operationId: extras_webhooks_list
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: query
|
|
name: content_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_types__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: payload_url
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: payload_url__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type_create
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: type_delete
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: type_update
|
|
schema:
|
|
type: boolean
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedWebhookList'
|
|
description: ''
|
|
post:
|
|
operationId: extras_webhooks_create
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
description: ''
|
|
put:
|
|
operationId: extras_webhooks_bulk_update
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_webhooks_bulk_partial_update
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebhook'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebhook'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebhook'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_webhooks_bulk_destroy
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/extras/webhooks/{id}/:
|
|
get:
|
|
operationId: extras_webhooks_retrieve
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this webhook.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
description: ''
|
|
put:
|
|
operationId: extras_webhooks_update
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this webhook.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
description: ''
|
|
patch:
|
|
operationId: extras_webhooks_partial_update
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this webhook.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebhook'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebhook'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebhook'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Webhook'
|
|
description: ''
|
|
delete:
|
|
operationId: extras_webhooks_destroy
|
|
description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this webhook.
|
|
required: true
|
|
tags:
|
|
- extras
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/graphql/:
|
|
post:
|
|
operationId: graphql_create
|
|
description: Query the database using a GraphQL query
|
|
tags:
|
|
- graphql
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLAPI'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLAPI'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GraphQLAPI'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: object
|
|
description: ''
|
|
'400':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
errors:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: ''
|
|
/ipam/aggregates/:
|
|
get:
|
|
operationId: ipam_aggregates_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: date_added
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: date_added__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: date_added__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: date_added__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: date_added__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: date_added__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: family
|
|
schema:
|
|
type: number
|
|
description: Family
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: prefix
|
|
schema:
|
|
type: string
|
|
description: Prefix
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rir
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: RIR (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rir__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: RIR (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rir_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: RIR (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rir_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: RIR (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedAggregateList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_aggregates_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_aggregates_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_aggregates_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableAggregate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableAggregate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableAggregate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_aggregates_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/aggregates/{id}/:
|
|
get:
|
|
operationId: ipam_aggregates_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this aggregate.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_aggregates_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this aggregate.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableAggregate'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_aggregates_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this aggregate.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableAggregate'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableAggregate'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableAggregate'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_aggregates_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this aggregate.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/ip-addresses/:
|
|
get:
|
|
operationId: ipam_ip_addresses_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: address
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: assigned_to_interface
|
|
schema:
|
|
type: boolean
|
|
description: Is assigned to an interface
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: dns_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: family
|
|
schema:
|
|
type: number
|
|
description: Family
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: interface
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Interface (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: interface__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Interface (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: interface_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Interface (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: interface_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Interface (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: mask_length
|
|
schema:
|
|
type: number
|
|
description: Mask length
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: parent
|
|
schema:
|
|
type: string
|
|
description: Parent prefix
|
|
- in: query
|
|
name: present_in_vrf
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: VRF (RD)
|
|
- in: query
|
|
name: present_in_vrf_id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: VRF
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: The functional role of this IP
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: The functional role of this IP
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Virtual machine (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Virtual machine (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vminterface
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: VM interface (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vminterface__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: VM interface (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vminterface_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: VM interface (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vminterface_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: VM interface (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VRF
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedIPAddressList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_ip_addresses_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_ip_addresses_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_ip_addresses_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableIPAddress'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableIPAddress'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableIPAddress'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_ip_addresses_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/ip-addresses/{id}/:
|
|
get:
|
|
operationId: ipam_ip_addresses_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this IP address.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_ip_addresses_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this IP address.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableIPAddress'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_ip_addresses_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this IP address.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableIPAddress'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableIPAddress'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableIPAddress'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_ip_addresses_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this IP address.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/prefixes/:
|
|
get:
|
|
operationId: ipam_prefixes_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: contains
|
|
schema:
|
|
type: string
|
|
description: Prefixes which contain this prefix or IP
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: family
|
|
schema:
|
|
type: number
|
|
description: Family
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: is_pool
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: mask_length
|
|
schema:
|
|
type: number
|
|
description: mask_length
|
|
- in: query
|
|
name: mask_length__gte
|
|
schema:
|
|
type: number
|
|
description: mask_length__gte
|
|
- in: query
|
|
name: mask_length__lte
|
|
schema:
|
|
type: number
|
|
description: mask_length__lte
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: prefix
|
|
schema:
|
|
type: string
|
|
description: Prefix
|
|
- in: query
|
|
name: present_in_vrf
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: VRF (RD)
|
|
- in: query
|
|
name: present_in_vrf_id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: VRF
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vlan_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VLAN (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vlan_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VLAN (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vlan_vid
|
|
schema:
|
|
type: integer
|
|
description: VLAN number (1-4095)
|
|
- in: query
|
|
name: vrf
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vrf_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: within
|
|
schema:
|
|
type: string
|
|
description: Within prefix
|
|
- in: query
|
|
name: within_include
|
|
schema:
|
|
type: string
|
|
description: Within and including prefix
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedPrefixList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_prefixes_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_prefixes_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_prefixes_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePrefix'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePrefix'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePrefix'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_prefixes_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/prefixes/{id}/:
|
|
get:
|
|
operationId: ipam_prefixes_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this prefix.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_prefixes_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this prefix.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritablePrefix'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_prefixes_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this prefix.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePrefix'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePrefix'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritablePrefix'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_prefixes_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this prefix.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/prefixes/{id}/available-ips/:
|
|
get:
|
|
operationId: ipam_prefixes_available_ips_list
|
|
description: |-
|
|
A convenience method for returning available IP addresses within a prefix. By default, the number of IPs
|
|
returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,
|
|
however results will not be paginated.
|
|
|
|
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
|
|
invoked in parallel, which results in a race condition where multiple insertions can occur.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this IP address.
|
|
required: true
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedAvailableIPList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_prefixes_available_ips_create
|
|
description: |-
|
|
A convenience method for returning available IP addresses within a prefix. By default, the number of IPs
|
|
returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,
|
|
however results will not be paginated.
|
|
|
|
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
|
|
invoked in parallel, which results in a race condition where multiple insertions can occur.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this IP address.
|
|
required: true
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AvailableIP'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AvailableIP'
|
|
multipart/form-data:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AvailableIP'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedAvailableIPList'
|
|
description: ''
|
|
/ipam/prefixes/{id}/available-prefixes/:
|
|
get:
|
|
operationId: ipam_prefixes_available_prefixes_list
|
|
description: |-
|
|
A convenience method for returning available child prefixes within a parent.
|
|
|
|
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
|
|
invoked in parallel, which results in a race condition where multiple insertions can occur.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this prefix.
|
|
required: true
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedAvailablePrefixList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_prefixes_available_prefixes_create
|
|
description: |-
|
|
A convenience method for returning available child prefixes within a parent.
|
|
|
|
The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
|
|
invoked in parallel, which results in a race condition where multiple insertions can occur.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this prefix.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PrefixLength'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PrefixLength'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PrefixLength'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Prefix'
|
|
description: ''
|
|
/ipam/rirs/:
|
|
get:
|
|
operationId: ipam_rirs_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: is_private
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRIRList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_rirs_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_rirs_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_rirs_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRIR'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRIR'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRIR'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_rirs_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/rirs/{id}/:
|
|
get:
|
|
operationId: ipam_rirs_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this RIR.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_rirs_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this RIR.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_rirs_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this RIR.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRIR'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRIR'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRIR'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RIR'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_rirs_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this RIR.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/roles/:
|
|
get:
|
|
operationId: ipam_roles_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRoleList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_roles_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_roles_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_roles_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRole'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_roles_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/roles/{id}/:
|
|
get:
|
|
operationId: ipam_roles_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this role.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_roles_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this role.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_roles_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this role.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRole'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRole'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRole'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Role'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_roles_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this role.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/route-targets/:
|
|
get:
|
|
operationId: ipam_route_targets_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: exporting_vrf
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Export VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: exporting_vrf__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Export VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: exporting_vrf_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Exporting VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: exporting_vrf_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Exporting VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: importing_vrf
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Import VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: importing_vrf__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Import VRF (RD)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: importing_vrf_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Importing VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: importing_vrf_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Importing VRF
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRouteTargetList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_route_targets_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_route_targets_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_route_targets_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRouteTarget'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRouteTarget'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRouteTarget'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_route_targets_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/route-targets/{id}/:
|
|
get:
|
|
operationId: ipam_route_targets_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this route target.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_route_targets_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this route target.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableRouteTarget'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_route_targets_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this route target.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRouteTarget'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRouteTarget'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableRouteTarget'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_route_targets_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this route target.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/services/:
|
|
get:
|
|
operationId: ipam_services_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Device (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: port
|
|
schema:
|
|
type: number
|
|
- in: query
|
|
name: protocol
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: protocol__n
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Virtual machine (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Virtual machine (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Virtual machine (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Virtual machine (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedServiceList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_services_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Service'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_services_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Service'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_services_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableService'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableService'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableService'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Service'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_services_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/services/{id}/:
|
|
get:
|
|
operationId: ipam_services_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this service.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Service'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_services_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this service.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableService'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Service'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_services_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this service.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableService'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableService'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableService'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Service'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_services_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this service.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/vlan-groups/:
|
|
get:
|
|
operationId: ipam_vlan_groups_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVLANGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_vlan_groups_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_vlan_groups_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_vlan_groups_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLANGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLANGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLANGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_vlan_groups_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/vlan-groups/{id}/:
|
|
get:
|
|
operationId: ipam_vlan_groups_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN group.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_vlan_groups_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN group.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLANGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_vlan_groups_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN group.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLANGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLANGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLANGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_vlan_groups_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN group.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/vlans/:
|
|
get:
|
|
operationId: ipam_vlans_list
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vid
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vid__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vid__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vid__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vid__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vid__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVLANList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_vlans_create
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLAN'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_vlans_bulk_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLAN'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_vlans_bulk_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLAN'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLAN'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLAN'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLAN'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_vlans_bulk_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/vlans/{id}/:
|
|
get:
|
|
operationId: ipam_vlans_retrieve
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLAN'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_vlans_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVLAN'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLAN'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_vlans_partial_update
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLAN'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLAN'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVLAN'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VLAN'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_vlans_destroy
|
|
description: Mixin to set `metadata_class` to implement `status` field in model
|
|
viewset metadata.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VLAN.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/vrfs/:
|
|
get:
|
|
operationId: ipam_vrfs_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: enforce_unique
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: export_target
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Export target (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: export_target__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Export target (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: export_target_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Export target
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: export_target_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Export target
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: import_target
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Import target (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: import_target__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Import target (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: import_target_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Import target
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: import_target_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Import target
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rd
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rd__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVRFList'
|
|
description: ''
|
|
post:
|
|
operationId: ipam_vrfs_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VRF'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_vrfs_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VRF'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_vrfs_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVRF'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVRF'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVRF'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VRF'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_vrfs_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/ipam/vrfs/{id}/:
|
|
get:
|
|
operationId: ipam_vrfs_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VRF.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VRF'
|
|
description: ''
|
|
put:
|
|
operationId: ipam_vrfs_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VRF.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVRF'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VRF'
|
|
description: ''
|
|
patch:
|
|
operationId: ipam_vrfs_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VRF.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVRF'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVRF'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVRF'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VRF'
|
|
description: ''
|
|
delete:
|
|
operationId: ipam_vrfs_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VRF.
|
|
required: true
|
|
tags:
|
|
- ipam
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/chatops/accessgrant/:
|
|
get:
|
|
operationId: plugins_chatops_accessgrant_list
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
parameters:
|
|
- in: query
|
|
name: command
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: grant_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: subcommand
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: value
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedAccessGrantList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_chatops_accessgrant_create
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_chatops_accessgrant_bulk_update
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_chatops_accessgrant_bulk_partial_update
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedAccessGrant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedAccessGrant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedAccessGrant'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_chatops_accessgrant_bulk_destroy
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/chatops/accessgrant/{id}/:
|
|
get:
|
|
operationId: plugins_chatops_accessgrant_retrieve
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this access grant.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_chatops_accessgrant_update
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this access grant.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_chatops_accessgrant_partial_update
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this access grant.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedAccessGrant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedAccessGrant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedAccessGrant'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_chatops_accessgrant_destroy
|
|
description: API viewset for interacting with AccessGrant objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this access grant.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/chatops/commandtoken/:
|
|
get:
|
|
operationId: plugins_chatops_commandtoken_list
|
|
description: API viewset for interacting with CommandToken objects.
|
|
parameters:
|
|
- in: query
|
|
name: comment
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCommandTokenList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_chatops_commandtoken_create
|
|
description: API viewset for interacting with CommandToken objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_chatops_commandtoken_bulk_update
|
|
description: API viewset for interacting with CommandToken objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_chatops_commandtoken_bulk_partial_update
|
|
description: API viewset for interacting with CommandToken objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCommandToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCommandToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCommandToken'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_chatops_commandtoken_bulk_destroy
|
|
description: API viewset for interacting with CommandToken objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/chatops/commandtoken/{id}/:
|
|
get:
|
|
operationId: plugins_chatops_commandtoken_retrieve
|
|
description: API viewset for interacting with CommandToken objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this command token.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_chatops_commandtoken_update
|
|
description: API viewset for interacting with CommandToken objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this command token.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_chatops_commandtoken_partial_update
|
|
description: API viewset for interacting with CommandToken objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this command token.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCommandToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCommandToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCommandToken'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_chatops_commandtoken_destroy
|
|
description: API viewset for interacting with CommandToken objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this command token.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/circuitimpact/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_list
|
|
description: API view for Circuit Impact CRUD operations.
|
|
parameters:
|
|
- in: query
|
|
name: circuit
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: circuit__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: impact
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
- in: query
|
|
name: impact__n
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: maintenance
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: maintenance__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCircuitMaintenanceCircuitImpactList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_create
|
|
description: API view for Circuit Impact CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_bulk_update
|
|
description: API view for Circuit Impact CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_bulk_partial_update
|
|
description: API view for Circuit Impact CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_bulk_destroy
|
|
description: API view for Circuit Impact CRUD operations.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/circuitimpact/{id}/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_retrieve
|
|
description: API view for Circuit Impact CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit impact.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_update
|
|
description: API view for Circuit Impact CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit impact.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_partial_update
|
|
description: API view for Circuit Impact CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit impact.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_circuit_maintenance_circuitimpact_destroy
|
|
description: API view for Circuit Impact CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit impact.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/maintenance/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_maintenance_list
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
parameters:
|
|
- in: query
|
|
name: ack
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: circuit
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Circuit
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: end_time
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: provider
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Provider (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: start_time
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCircuitMaintenanceList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_circuit_maintenance_maintenance_create
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_circuit_maintenance_maintenance_bulk_update
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_circuit_maintenance_maintenance_bulk_partial_update
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenance'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_circuit_maintenance_maintenance_bulk_destroy
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/maintenance/{id}/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_maintenance_retrieve
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit maintenance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_circuit_maintenance_maintenance_update
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit maintenance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_circuit_maintenance_maintenance_partial_update
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit maintenance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCircuitMaintenance'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_circuit_maintenance_maintenance_destroy
|
|
description: API view for Circuit Maintenance CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this circuit maintenance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/note/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_note_list
|
|
description: API view for Circuit Note CRUD operations.
|
|
parameters:
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedNoteList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_circuit_maintenance_note_create
|
|
description: API view for Circuit Note CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_circuit_maintenance_note_bulk_update
|
|
description: API view for Circuit Note CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_circuit_maintenance_note_bulk_partial_update
|
|
description: API view for Circuit Note CRUD operations.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNote'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNote'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNote'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_circuit_maintenance_note_bulk_destroy
|
|
description: API view for Circuit Note CRUD operations.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/note/{id}/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_note_retrieve
|
|
description: API view for Circuit Note CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this note.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_circuit_maintenance_note_update
|
|
description: API view for Circuit Note CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this note.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_circuit_maintenance_note_partial_update
|
|
description: API view for Circuit Note CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this note.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNote'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNote'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNote'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Note'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_circuit_maintenance_note_destroy
|
|
description: API view for Circuit Note CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this note.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/circuit-maintenance/notificationsource/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_notificationsource_list
|
|
description: API view for Notification Source CRUD operations.
|
|
parameters:
|
|
- in: query
|
|
name: attach_all_providers
|
|
schema:
|
|
type: boolean
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedNotificationSourceList'
|
|
description: ''
|
|
/plugins/circuit-maintenance/notificationsource/{id}/:
|
|
get:
|
|
operationId: plugins_circuit_maintenance_notificationsource_retrieve
|
|
description: API view for Notification Source CRUD operations.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this notification source.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationSource'
|
|
description: ''
|
|
/plugins/data-validation-engine/rules/min-max/:
|
|
get:
|
|
operationId: plugins_data_validation_engine_rules_min_max_list
|
|
description: View to manage min max expression validation rules
|
|
parameters:
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: error_message
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: max
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: max__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: min
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: min__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: min__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: min__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: min__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: min__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: float
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedMinMaxValidationRuleList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_data_validation_engine_rules_min_max_create
|
|
description: View to manage min max expression validation rules
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_data_validation_engine_rules_min_max_bulk_update
|
|
description: View to manage min max expression validation rules
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_data_validation_engine_rules_min_max_bulk_partial_update
|
|
description: View to manage min max expression validation rules
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedMinMaxValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedMinMaxValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedMinMaxValidationRule'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_data_validation_engine_rules_min_max_bulk_destroy
|
|
description: View to manage min max expression validation rules
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/data-validation-engine/rules/min-max/{id}/:
|
|
get:
|
|
operationId: plugins_data_validation_engine_rules_min_max_retrieve
|
|
description: View to manage min max expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this min max validation rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_data_validation_engine_rules_min_max_update
|
|
description: View to manage min max expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this min max validation rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_data_validation_engine_rules_min_max_partial_update
|
|
description: View to manage min max expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this min max validation rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedMinMaxValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedMinMaxValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedMinMaxValidationRule'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_data_validation_engine_rules_min_max_destroy
|
|
description: View to manage min max expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this min max validation rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/data-validation-engine/rules/regex/:
|
|
get:
|
|
operationId: plugins_data_validation_engine_rules_regex_list
|
|
description: View to manage regular expression validation rules
|
|
parameters:
|
|
- in: query
|
|
name: content_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: content_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: error_message
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: error_message__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: field__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: regular_expression
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: regular_expression__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRegularExpressionValidationRuleList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_data_validation_engine_rules_regex_create
|
|
description: View to manage regular expression validation rules
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_data_validation_engine_rules_regex_bulk_update
|
|
description: View to manage regular expression validation rules
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_data_validation_engine_rules_regex_bulk_partial_update
|
|
description: View to manage regular expression validation rules
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_data_validation_engine_rules_regex_bulk_destroy
|
|
description: View to manage regular expression validation rules
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/data-validation-engine/rules/regex/{id}/:
|
|
get:
|
|
operationId: plugins_data_validation_engine_rules_regex_retrieve
|
|
description: View to manage regular expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this regular expression validation
|
|
rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_data_validation_engine_rules_regex_update
|
|
description: View to manage regular expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this regular expression validation
|
|
rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_data_validation_engine_rules_regex_partial_update
|
|
description: View to manage regular expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this regular expression validation
|
|
rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_data_validation_engine_rules_regex_destroy
|
|
description: View to manage regular expression validation rules
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this regular expression validation
|
|
rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/device-onboarding/onboarding/:
|
|
get:
|
|
operationId: plugins_device_onboarding_onboarding_list
|
|
description: |-
|
|
Create, check status of, and delete onboarding tasks.
|
|
|
|
In-place updates (PUT, PATCH) of tasks are not permitted.
|
|
parameters:
|
|
- in: query
|
|
name: failed_reason
|
|
schema:
|
|
type: string
|
|
nullable: true
|
|
description: Raison why the task failed (optional)
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: string
|
|
description: Overall status of the task
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedOnboardingTaskList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_device_onboarding_onboarding_create
|
|
description: |-
|
|
Create, check status of, and delete onboarding tasks.
|
|
|
|
In-place updates (PUT, PATCH) of tasks are not permitted.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OnboardingTask'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/OnboardingTask'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/OnboardingTask'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/OnboardingTask'
|
|
description: ''
|
|
/plugins/device-onboarding/onboarding/{id}/:
|
|
get:
|
|
operationId: plugins_device_onboarding_onboarding_retrieve
|
|
description: |-
|
|
Create, check status of, and delete onboarding tasks.
|
|
|
|
In-place updates (PUT, PATCH) of tasks are not permitted.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this onboarding task.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/OnboardingTask'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_device_onboarding_onboarding_destroy
|
|
description: |-
|
|
Create, check status of, and delete onboarding tasks.
|
|
|
|
In-place updates (PUT, PATCH) of tasks are not permitted.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this onboarding task.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/compliance-feature/:
|
|
get:
|
|
operationId: plugins_golden_config_compliance_feature_list
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
parameters:
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedComplianceFeatureList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_compliance_feature_create
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_compliance_feature_bulk_update
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_compliance_feature_bulk_partial_update
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceFeature'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceFeature'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceFeature'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_compliance_feature_bulk_destroy
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/compliance-feature/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_compliance_feature_retrieve
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance feature.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_compliance_feature_update
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance feature.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_compliance_feature_partial_update
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance feature.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceFeature'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceFeature'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceFeature'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_compliance_feature_destroy
|
|
description: API viewset for interacting with ComplianceFeature objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance feature.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/compliance-rule/:
|
|
get:
|
|
operationId: plugins_golden_config_compliance_rule_list
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
parameters:
|
|
- in: query
|
|
name: feature
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedComplianceRuleList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_compliance_rule_create
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_compliance_rule_bulk_update
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_compliance_rule_bulk_partial_update
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceRule'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_compliance_rule_bulk_destroy
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/compliance-rule/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_compliance_rule_retrieve
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_compliance_rule_update
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_compliance_rule_partial_update
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceRule'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceRule'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedComplianceRule'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_compliance_rule_destroy
|
|
description: API viewset for interacting with ComplianceRule objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this compliance rule.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/config-compliance/:
|
|
get:
|
|
operationId: plugins_golden_config_config_compliance_list
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
parameters:
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device Name
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device ID
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Status
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_status_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Device Status
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: DeviceType (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: manufacturer
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConfigComplianceList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_config_compliance_create
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_config_compliance_bulk_update
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_config_compliance_bulk_partial_update
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigCompliance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigCompliance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigCompliance'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_config_compliance_bulk_destroy
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/config-compliance/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_config_compliance_retrieve
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config compliance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_config_compliance_update
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config compliance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_config_compliance_partial_update
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config compliance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigCompliance'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigCompliance'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigCompliance'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_config_compliance_destroy
|
|
description: API viewset for interacting with ConfigCompliance objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config compliance.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/config-remove/:
|
|
get:
|
|
operationId: plugins_golden_config_config_remove_list
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
parameters:
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConfigRemoveList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_config_remove_create
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_config_remove_bulk_update
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_config_remove_bulk_partial_update
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigRemove'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigRemove'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigRemove'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_config_remove_bulk_destroy
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/config-remove/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_config_remove_retrieve
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config remove.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_config_remove_update
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config remove.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_config_remove_partial_update
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config remove.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigRemove'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigRemove'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigRemove'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_config_remove_destroy
|
|
description: API viewset for interacting with ConfigRemove objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config remove.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/config-replace/:
|
|
get:
|
|
operationId: plugins_golden_config_config_replace_list
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
parameters:
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedConfigReplaceList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_config_replace_create
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_config_replace_bulk_update
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_config_replace_bulk_partial_update
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigReplace'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigReplace'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigReplace'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_config_replace_bulk_destroy
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/config-replace/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_config_replace_retrieve
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config replace.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_config_replace_update
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config replace.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_config_replace_partial_update
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config replace.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigReplace'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigReplace'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedConfigReplace'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_config_replace_destroy
|
|
description: API viewset for interacting with ConfigReplace objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this config replace.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/golden-config/:
|
|
get:
|
|
operationId: plugins_golden_config_golden_config_list
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
parameters:
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Device Name
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device ID
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Status
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_status_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Device Status
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: DeviceType (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: manufacturer
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Manufacturer (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: manufacturer_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Manufacturer (ID)
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: rack
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Rack group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: rack_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Rack (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site name (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedGoldenConfigList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_golden_config_create
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_golden_config_bulk_update
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_golden_config_bulk_partial_update
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfig'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfig'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfig'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_golden_config_bulk_destroy
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/golden-config-settings/:
|
|
get:
|
|
operationId: plugins_golden_config_golden_config_settings_list
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
parameters:
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedGoldenConfigSettingList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_golden_config_golden_config_settings_create
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_golden_config_settings_bulk_update
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_golden_config_settings_bulk_partial_update
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfigSetting'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfigSetting'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfigSetting'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_golden_config_settings_bulk_destroy
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/golden-config-settings/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_golden_config_settings_retrieve
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Golden Config Setting.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_golden_config_settings_update
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Golden Config Setting.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_golden_config_settings_partial_update
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Golden Config Setting.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfigSetting'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfigSetting'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfigSetting'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_golden_config_settings_destroy
|
|
description: API viewset for interacting with GoldenConfigSetting objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Golden Config Setting.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/golden-config/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_golden_config_retrieve
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this golden config.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_golden_config_golden_config_update
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this golden config.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_golden_config_golden_config_partial_update
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this golden config.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfig'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfig'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGoldenConfig'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_golden_config_golden_config_destroy
|
|
description: API viewset for interacting with GoldenConfig objects.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this golden config.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/golden-config/sotagg/{id}/:
|
|
get:
|
|
operationId: plugins_golden_config_sotagg_retrieve
|
|
description: Get method serialize for a dictionary to json response.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/contact/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_list
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
parameters:
|
|
- in: query
|
|
name: address
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: comments
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: contract
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: email
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: phone
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: priority
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedContactLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_create
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_update
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_partial_update
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContactLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContactLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContactLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_destroy
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/contact/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_retrieve
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract POC.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_update
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract POC.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContactLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_partial_update
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract POC.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContactLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContactLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContactLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_destroy
|
|
description: CRUD operations set for the Contact Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract POC.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/contract/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_list
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
parameters:
|
|
- in: query
|
|
name: contract_type
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: cost
|
|
schema:
|
|
type: number
|
|
- in: query
|
|
name: end
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: expired
|
|
schema:
|
|
type: boolean
|
|
description: Expired
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: provider
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Provider
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: start
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: start__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: start__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: support_level
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedContractLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_create
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_update
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_partial_update
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContractLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContractLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContractLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_destroy
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/contract/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_retrieve
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_update
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableContractLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_partial_update
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContractLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContractLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableContractLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_destroy
|
|
description: CRUD operations set for the Contract Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Contract.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/cve/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_list
|
|
description: REST API viewset for CVELCM records.
|
|
parameters:
|
|
- in: query
|
|
name: comments
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: cvss
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss__gte
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss__lte
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss_v2
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss_v2__gte
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss_v2__lte
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss_v3
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss_v3__gte
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: cvss_v3__lte
|
|
schema:
|
|
type: number
|
|
format: float
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: exclude_status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: fix
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: link
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: published_date__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: published_date__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: published_date_after
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: published_date_before
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: severity
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCVELCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_create
|
|
description: REST API viewset for CVELCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_update
|
|
description: REST API viewset for CVELCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_partial_update
|
|
description: REST API viewset for CVELCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCVELCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCVELCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCVELCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_destroy
|
|
description: REST API viewset for CVELCM records.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/cve/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_retrieve
|
|
description: REST API viewset for CVELCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this CVE.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_update
|
|
description: REST API viewset for CVELCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this CVE.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_partial_update
|
|
description: REST API viewset for CVELCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this CVE.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCVELCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCVELCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCVELCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_destroy
|
|
description: REST API viewset for CVELCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this CVE.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/hardware/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_list
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
parameters:
|
|
- in: query
|
|
name: device_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Type (Slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Type
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: documentation_url
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: end_of_sale
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_sale__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_sale__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_security_patches
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_security_patches__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_security_patches__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_support
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_support__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_support__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_sw_releases
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_sw_releases__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: end_of_sw_releases__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: expired
|
|
schema:
|
|
type: boolean
|
|
description: Expired
|
|
- in: query
|
|
name: inventory_item
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
title: Inventory Item Part
|
|
description: Inventory Part ID
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedHardwareLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_create
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_update
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_partial_update
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableHardwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableHardwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableHardwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_destroy
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/hardware/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_retrieve
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Hardware Notice.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_update
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Hardware Notice.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableHardwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_partial_update
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Hardware Notice.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableHardwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableHardwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableHardwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_destroy
|
|
description: CRUD operations set for the Hardware Lifecycle Management view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Hardware Notice.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/provider/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_list
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
parameters:
|
|
- in: query
|
|
name: comments
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: country
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: email
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: phone
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: physical_address
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: portal_url
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedProviderLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_create
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_update
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_partial_update
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProviderLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProviderLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProviderLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_destroy
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/provider/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_retrieve
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vendor.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_update
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vendor.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_partial_update
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vendor.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProviderLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProviderLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedProviderLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_destroy
|
|
description: CRUD operations set for the Contract Provider Lifecycle Management
|
|
view.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vendor.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/software/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_list
|
|
description: REST API viewset for SoftwareLCM records.
|
|
parameters:
|
|
- in: query
|
|
name: alias
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: device_platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Platform (Slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: documentation_url
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: end_of_support_after
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: end_of_support_before
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: long_term_support
|
|
schema:
|
|
type: boolean
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: pre_release
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: release_date_after
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: release_date_before
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: version
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSoftwareLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_create
|
|
description: REST API viewset for SoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_update
|
|
description: REST API viewset for SoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_partial_update
|
|
description: REST API viewset for SoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_destroy
|
|
description: REST API viewset for SoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/software-image/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_list
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
parameters:
|
|
- in: query
|
|
name: default_image
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: string
|
|
description: Device ID
|
|
- in: query
|
|
name: device_name
|
|
schema:
|
|
type: string
|
|
description: Device Name
|
|
- in: query
|
|
name: device_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Types (model)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_types_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Types
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: download_url
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: image_file_checksum
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: image_file_name
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: inventory_item_id
|
|
schema:
|
|
type: string
|
|
description: InventoryItem ID
|
|
- in: query
|
|
name: inventory_items
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Inventory Items (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: inventory_items_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Inventory Items
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: object_tags
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Object Tags (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_tags_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Object Tags
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: software
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Software
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: software_version
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Software (version)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSoftwareImageLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_create
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_update
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_partial_update
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_destroy
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/software-image/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_retrieve
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software Image.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_update
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software Image.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareImageLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_partial_update
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software Image.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_destroy
|
|
description: REST API viewset for SoftwareImageLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software Image.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/software/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_retrieve
|
|
description: REST API viewset for SoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_update
|
|
description: REST API viewset for SoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableSoftwareLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_partial_update
|
|
description: REST API viewset for SoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableSoftwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_software_destroy
|
|
description: REST API viewset for SoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/validated-software/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_list
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
parameters:
|
|
- in: query
|
|
name: device_id
|
|
schema:
|
|
type: string
|
|
description: Device ID
|
|
- in: query
|
|
name: device_name
|
|
schema:
|
|
type: string
|
|
description: Device Name
|
|
- in: query
|
|
name: device_roles
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Roles (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_roles_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Roles
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Device Types (model)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: device_types_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Device Types
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devices
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: Devices (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: devices_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Devices
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: end_after
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: end_before
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: inventory_item_id
|
|
schema:
|
|
type: string
|
|
description: InventoryItem ID
|
|
- in: query
|
|
name: inventory_items
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Inventory Items (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: inventory_items_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Inventory Items
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: object_tags
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Object Tags (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_tags_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Object Tags
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: preferred
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: software
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Software
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: start_after
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: start_before
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: valid
|
|
schema:
|
|
type: boolean
|
|
description: Currently valid
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedValidatedSoftwareLCMList'
|
|
description: ''
|
|
post:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_create
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_update
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_partial_update
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_destroy
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/validated-software/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_retrieve
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Validated Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_update
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Validated Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableValidatedSoftwareLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_partial_update
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Validated Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_destroy
|
|
description: REST API viewset for ValidatedSoftwareLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Validated Software.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/vulnerability/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_list
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
parameters:
|
|
- in: query
|
|
name: cve
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: cve__published_date__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: cve__published_date__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: cve__published_date_after
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: cve__published_date_before
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: device
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: exclude_status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: inventory_item
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: software
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVulnerabilityLCMList'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_update
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_partial_update
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedVulnerabilityLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedVulnerabilityLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedVulnerabilityLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_destroy
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/plugins/nautobot-device-lifecycle-mgmt/vulnerability/{id}/:
|
|
get:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_retrieve
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vulnerability.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
description: ''
|
|
put:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_update
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vulnerability.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
description: ''
|
|
patch:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_partial_update
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vulnerability.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedVulnerabilityLCM'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedVulnerabilityLCM'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedVulnerabilityLCM'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
description: ''
|
|
delete:
|
|
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_destroy
|
|
description: REST API viewset for VulnerabilityLCM records.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Vulnerability.
|
|
required: true
|
|
tags:
|
|
- plugins
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/status/:
|
|
get:
|
|
operationId: status_retrieve
|
|
description: A lightweight read-only endpoint for conveying the current operational
|
|
status.
|
|
tags:
|
|
- status
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
django-version:
|
|
type: string
|
|
installed-apps:
|
|
type: object
|
|
nautobot-version:
|
|
type: string
|
|
plugins:
|
|
type: object
|
|
python-version:
|
|
type: string
|
|
rq-workers-running:
|
|
type: integer
|
|
celery-workers-running:
|
|
type: integer
|
|
description: ''
|
|
/swagger/:
|
|
get:
|
|
operationId: swagger_retrieve
|
|
description: |-
|
|
OpenApi3 schema for this API. Format can be selected via content negotiation.
|
|
|
|
- YAML: application/vnd.oai.openapi
|
|
- JSON: application/vnd.oai.openapi+json
|
|
parameters:
|
|
- in: query
|
|
name: format
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- json
|
|
- yaml
|
|
- in: query
|
|
name: lang
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- af
|
|
- ar
|
|
- ar-dz
|
|
- ast
|
|
- az
|
|
- be
|
|
- bg
|
|
- bn
|
|
- br
|
|
- bs
|
|
- ca
|
|
- cs
|
|
- cy
|
|
- da
|
|
- de
|
|
- dsb
|
|
- el
|
|
- en
|
|
- en-au
|
|
- en-gb
|
|
- eo
|
|
- es
|
|
- es-ar
|
|
- es-co
|
|
- es-mx
|
|
- es-ni
|
|
- es-ve
|
|
- et
|
|
- eu
|
|
- fa
|
|
- fi
|
|
- fr
|
|
- fy
|
|
- ga
|
|
- gd
|
|
- gl
|
|
- he
|
|
- hi
|
|
- hr
|
|
- hsb
|
|
- hu
|
|
- hy
|
|
- ia
|
|
- id
|
|
- ig
|
|
- io
|
|
- is
|
|
- it
|
|
- ja
|
|
- ka
|
|
- kab
|
|
- kk
|
|
- km
|
|
- kn
|
|
- ko
|
|
- ky
|
|
- lb
|
|
- lt
|
|
- lv
|
|
- mk
|
|
- ml
|
|
- mn
|
|
- mr
|
|
- my
|
|
- nb
|
|
- ne
|
|
- nl
|
|
- nn
|
|
- os
|
|
- pa
|
|
- pl
|
|
- pt
|
|
- pt-br
|
|
- ro
|
|
- ru
|
|
- sk
|
|
- sl
|
|
- sq
|
|
- sr
|
|
- sr-latn
|
|
- sv
|
|
- sw
|
|
- ta
|
|
- te
|
|
- tg
|
|
- th
|
|
- tk
|
|
- tr
|
|
- tt
|
|
- udm
|
|
- uk
|
|
- ur
|
|
- uz
|
|
- vi
|
|
- zh-hans
|
|
- zh-hant
|
|
tags:
|
|
- swagger
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/vnd.oai.openapi; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
application/yaml; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
application/vnd.oai.openapi+json; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: ''
|
|
/swagger.json:
|
|
get:
|
|
operationId: swagger.json_retrieve
|
|
description: |-
|
|
OpenApi3 schema for this API. Format can be selected via content negotiation.
|
|
|
|
- YAML: application/vnd.oai.openapi
|
|
- JSON: application/vnd.oai.openapi+json
|
|
parameters:
|
|
- in: query
|
|
name: lang
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- af
|
|
- ar
|
|
- ar-dz
|
|
- ast
|
|
- az
|
|
- be
|
|
- bg
|
|
- bn
|
|
- br
|
|
- bs
|
|
- ca
|
|
- cs
|
|
- cy
|
|
- da
|
|
- de
|
|
- dsb
|
|
- el
|
|
- en
|
|
- en-au
|
|
- en-gb
|
|
- eo
|
|
- es
|
|
- es-ar
|
|
- es-co
|
|
- es-mx
|
|
- es-ni
|
|
- es-ve
|
|
- et
|
|
- eu
|
|
- fa
|
|
- fi
|
|
- fr
|
|
- fy
|
|
- ga
|
|
- gd
|
|
- gl
|
|
- he
|
|
- hi
|
|
- hr
|
|
- hsb
|
|
- hu
|
|
- hy
|
|
- ia
|
|
- id
|
|
- ig
|
|
- io
|
|
- is
|
|
- it
|
|
- ja
|
|
- ka
|
|
- kab
|
|
- kk
|
|
- km
|
|
- kn
|
|
- ko
|
|
- ky
|
|
- lb
|
|
- lt
|
|
- lv
|
|
- mk
|
|
- ml
|
|
- mn
|
|
- mr
|
|
- my
|
|
- nb
|
|
- ne
|
|
- nl
|
|
- nn
|
|
- os
|
|
- pa
|
|
- pl
|
|
- pt
|
|
- pt-br
|
|
- ro
|
|
- ru
|
|
- sk
|
|
- sl
|
|
- sq
|
|
- sr
|
|
- sr-latn
|
|
- sv
|
|
- sw
|
|
- ta
|
|
- te
|
|
- tg
|
|
- th
|
|
- tk
|
|
- tr
|
|
- tt
|
|
- udm
|
|
- uk
|
|
- ur
|
|
- uz
|
|
- vi
|
|
- zh-hans
|
|
- zh-hant
|
|
tags:
|
|
- swagger.json
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/vnd.oai.openapi+json; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: ''
|
|
/swagger.yaml:
|
|
get:
|
|
operationId: swagger.yaml_retrieve
|
|
description: |-
|
|
OpenApi3 schema for this API. Format can be selected via content negotiation.
|
|
|
|
- YAML: application/vnd.oai.openapi
|
|
- JSON: application/vnd.oai.openapi+json
|
|
parameters:
|
|
- in: query
|
|
name: lang
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- af
|
|
- ar
|
|
- ar-dz
|
|
- ast
|
|
- az
|
|
- be
|
|
- bg
|
|
- bn
|
|
- br
|
|
- bs
|
|
- ca
|
|
- cs
|
|
- cy
|
|
- da
|
|
- de
|
|
- dsb
|
|
- el
|
|
- en
|
|
- en-au
|
|
- en-gb
|
|
- eo
|
|
- es
|
|
- es-ar
|
|
- es-co
|
|
- es-mx
|
|
- es-ni
|
|
- es-ve
|
|
- et
|
|
- eu
|
|
- fa
|
|
- fi
|
|
- fr
|
|
- fy
|
|
- ga
|
|
- gd
|
|
- gl
|
|
- he
|
|
- hi
|
|
- hr
|
|
- hsb
|
|
- hu
|
|
- hy
|
|
- ia
|
|
- id
|
|
- ig
|
|
- io
|
|
- is
|
|
- it
|
|
- ja
|
|
- ka
|
|
- kab
|
|
- kk
|
|
- km
|
|
- kn
|
|
- ko
|
|
- ky
|
|
- lb
|
|
- lt
|
|
- lv
|
|
- mk
|
|
- ml
|
|
- mn
|
|
- mr
|
|
- my
|
|
- nb
|
|
- ne
|
|
- nl
|
|
- nn
|
|
- os
|
|
- pa
|
|
- pl
|
|
- pt
|
|
- pt-br
|
|
- ro
|
|
- ru
|
|
- sk
|
|
- sl
|
|
- sq
|
|
- sr
|
|
- sr-latn
|
|
- sv
|
|
- sw
|
|
- ta
|
|
- te
|
|
- tg
|
|
- th
|
|
- tk
|
|
- tr
|
|
- tt
|
|
- udm
|
|
- uk
|
|
- ur
|
|
- uz
|
|
- vi
|
|
- zh-hans
|
|
- zh-hant
|
|
tags:
|
|
- swagger.yaml
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/vnd.oai.openapi; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
application/yaml; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: ''
|
|
/tenancy/tenant-groups/:
|
|
get:
|
|
operationId: tenancy_tenant_groups_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: parent
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant group group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant group group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: parent_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTenantGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: tenancy_tenant_groups_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
description: ''
|
|
put:
|
|
operationId: tenancy_tenant_groups_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: tenancy_tenant_groups_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenantGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenantGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenantGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: tenancy_tenant_groups_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/tenancy/tenant-groups/{id}/:
|
|
get:
|
|
operationId: tenancy_tenant_groups_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant group.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
description: ''
|
|
put:
|
|
operationId: tenancy_tenant_groups_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant group.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenantGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: tenancy_tenant_groups_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant group.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenantGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenantGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenantGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: tenancy_tenant_groups_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant group.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/tenancy/tenants/:
|
|
get:
|
|
operationId: tenancy_tenants_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTenantList'
|
|
description: ''
|
|
post:
|
|
operationId: tenancy_tenants_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
put:
|
|
operationId: tenancy_tenants_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
patch:
|
|
operationId: tenancy_tenants_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenant'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
delete:
|
|
operationId: tenancy_tenants_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/tenancy/tenants/{id}/:
|
|
get:
|
|
operationId: tenancy_tenants_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
put:
|
|
operationId: tenancy_tenants_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableTenant'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
patch:
|
|
operationId: tenancy_tenants_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenant'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenant'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableTenant'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
delete:
|
|
operationId: tenancy_tenants_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this tenant.
|
|
required: true
|
|
tags:
|
|
- tenancy
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/config/:
|
|
get:
|
|
operationId: users_config_retrieve
|
|
description: Return the config_data for the currently authenticated User.
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: ''
|
|
/users/groups/:
|
|
get:
|
|
operationId: users_groups_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: users_groups_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
put:
|
|
operationId: users_groups_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
patch:
|
|
operationId: users_groups_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
delete:
|
|
operationId: users_groups_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/groups/{id}/:
|
|
get:
|
|
operationId: users_groups_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this group.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
put:
|
|
operationId: users_groups_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this group.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
patch:
|
|
operationId: users_groups_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this group.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
delete:
|
|
operationId: users_groups_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this group.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/permissions/:
|
|
get:
|
|
operationId: users_permissions_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_types
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: object_types__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: user
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: User
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: user_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: User
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedObjectPermissionList'
|
|
description: ''
|
|
post:
|
|
operationId: users_permissions_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
description: ''
|
|
put:
|
|
operationId: users_permissions_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
description: ''
|
|
patch:
|
|
operationId: users_permissions_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableObjectPermission'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableObjectPermission'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableObjectPermission'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
description: ''
|
|
delete:
|
|
operationId: users_permissions_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/permissions/{id}/:
|
|
get:
|
|
operationId: users_permissions_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this permission.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
description: ''
|
|
put:
|
|
operationId: users_permissions_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this permission.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableObjectPermission'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
description: ''
|
|
patch:
|
|
operationId: users_permissions_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this permission.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableObjectPermission'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableObjectPermission'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableObjectPermission'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
description: ''
|
|
delete:
|
|
operationId: users_permissions_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this permission.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/tokens/:
|
|
get:
|
|
operationId: users_tokens_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: expires
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: expires__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: expires__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: expires__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: expires__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: expires__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: date-time
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: key__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: write_enabled
|
|
schema:
|
|
type: boolean
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTokenList'
|
|
description: ''
|
|
post:
|
|
operationId: users_tokens_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
put:
|
|
operationId: users_tokens_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
patch:
|
|
operationId: users_tokens_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedToken'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
delete:
|
|
operationId: users_tokens_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/tokens/{id}/:
|
|
get:
|
|
operationId: users_tokens_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this token.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
put:
|
|
operationId: users_tokens_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this token.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
patch:
|
|
operationId: users_tokens_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this token.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedToken'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedToken'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedToken'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
delete:
|
|
operationId: users_tokens_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this token.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
- basicAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/users/:
|
|
get:
|
|
operationId: users_users_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: email
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: email__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: first_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Group (name)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Group
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: is_active
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: is_staff
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: last_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: username
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: username__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedUserList'
|
|
description: ''
|
|
post:
|
|
operationId: users_users_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
put:
|
|
operationId: users_users_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
patch:
|
|
operationId: users_users_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableUser'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableUser'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableUser'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
delete:
|
|
operationId: users_users_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/users/users/{id}/:
|
|
get:
|
|
operationId: users_users_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this user.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
put:
|
|
operationId: users_users_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this user.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableUser'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
patch:
|
|
operationId: users_users_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this user.
|
|
required: true
|
|
tags:
|
|
- users
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableUser'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableUser'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableUser'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
delete:
|
|
operationId: users_users_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this user.
|
|
required: true
|
|
tags:
|
|
- users
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/cluster-groups/:
|
|
get:
|
|
operationId: virtualization_cluster_groups_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedClusterGroupList'
|
|
description: ''
|
|
post:
|
|
operationId: virtualization_cluster_groups_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_cluster_groups_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_cluster_groups_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_cluster_groups_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/cluster-groups/{id}/:
|
|
get:
|
|
operationId: virtualization_cluster_groups_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster group.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_cluster_groups_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster group.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_cluster_groups_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster group.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterGroup'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterGroup'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterGroup'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_cluster_groups_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster group.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/cluster-types/:
|
|
get:
|
|
operationId: virtualization_cluster_types_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: description__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: slug__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedClusterTypeList'
|
|
description: ''
|
|
post:
|
|
operationId: virtualization_cluster_types_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_cluster_types_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_cluster_types_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterType'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_cluster_types_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/cluster-types/{id}/:
|
|
get:
|
|
operationId: virtualization_cluster_types_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster type.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_cluster_types_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster type.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_cluster_types_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster type.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterType'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterType'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedClusterType'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_cluster_types_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster type.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/clusters/:
|
|
get:
|
|
operationId: virtualization_clusters_list
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Parent group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Parent group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Parent group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Parent group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: type_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster type (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedClusterList'
|
|
description: ''
|
|
post:
|
|
operationId: virtualization_clusters_create
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cluster'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_clusters_bulk_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cluster'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_clusters_bulk_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCluster'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCluster'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCluster'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cluster'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_clusters_bulk_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/clusters/{id}/:
|
|
get:
|
|
operationId: virtualization_clusters_retrieve
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cluster'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_clusters_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableCluster'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cluster'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_clusters_partial_update
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCluster'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCluster'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableCluster'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/Cluster'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_clusters_destroy
|
|
description: Include the applicable set of CustomFields in the ModelViewSet
|
|
context.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this cluster.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/interfaces/:
|
|
get:
|
|
operationId: virtualization_interfaces_list
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: query
|
|
name: cluster
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: enabled
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: mac_address
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mtu__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Virtual machine
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Virtual machine
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Virtual machine (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: virtual_machine_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Virtual machine (ID)
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVMInterfaceList'
|
|
description: ''
|
|
post:
|
|
operationId: virtualization_interfaces_create
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_interfaces_bulk_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_interfaces_bulk_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVMInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVMInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVMInterface'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_interfaces_bulk_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/interfaces/{id}/:
|
|
get:
|
|
operationId: virtualization_interfaces_retrieve
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VM interface.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_interfaces_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VM interface.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVMInterface'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_interfaces_partial_update
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VM interface.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVMInterface'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVMInterface'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVMInterface'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_interfaces_destroy
|
|
description: Extend DRF's ModelViewSet to support bulk update and delete functions.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this VM interface.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/virtual-machines/:
|
|
get:
|
|
operationId: virtualization_virtual_machines_list
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: query
|
|
name: cluster
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: cluster__n
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: cluster_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_type
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_type__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cluster type (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_type_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: cluster_type_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Cluster type (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__gte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: created__lte
|
|
schema:
|
|
type: string
|
|
format: date
|
|
- in: query
|
|
name: disk
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: disk__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: disk__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: disk__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: disk__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: disk__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: has_primary_ip
|
|
schema:
|
|
type: boolean
|
|
description: Has a primary IP
|
|
- in: query
|
|
name: id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: id__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: last_updated
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__gte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: last_updated__lte
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: limit
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: local_context_data
|
|
schema:
|
|
type: boolean
|
|
description: Has local config context data
|
|
- in: query
|
|
name: local_context_schema
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Schema (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: local_context_schema__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Schema (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: local_context_schema_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Schema (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: local_context_schema_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Schema (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: mac_address__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: MAC address
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: memory
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: memory__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: memory__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: memory__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: memory__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: memory__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__iew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__ire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__isw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nic
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nie
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__niew
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nire
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nisw
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__nre
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name__re
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- name: offset
|
|
required: false
|
|
in: query
|
|
description: The initial index from which to return the results.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: platform
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Platform (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: platform_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Platform (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: q
|
|
schema:
|
|
type: string
|
|
description: Search
|
|
- in: query
|
|
name: region
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: region_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Region (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Role (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: role_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Role (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Site (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: site_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Site (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: status__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tag__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Tenant (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (slug)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_group_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: Tenant Group (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: tenant_id__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Tenant (ID)
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vcpus
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vcpus__gt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vcpus__gte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vcpus__lt
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vcpus__lte
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: vcpus__n
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedVirtualMachineWithConfigContextList'
|
|
description: ''
|
|
post:
|
|
operationId: virtualization_virtual_machines_create
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_virtual_machines_bulk_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_virtual_machines_bulk_partial_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_virtual_machines_bulk_destroy
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
/virtualization/virtual-machines/{id}/:
|
|
get:
|
|
operationId: virtualization_virtual_machines_retrieve
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual machine.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
description: ''
|
|
put:
|
|
operationId: virtualization_virtual_machines_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual machine.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
|
|
required: true
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
description: ''
|
|
patch:
|
|
operationId: virtualization_virtual_machines_partial_update
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual machine.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json; version=1.3:
|
|
schema:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
description: ''
|
|
delete:
|
|
operationId: virtualization_virtual_machines_destroy
|
|
description: |-
|
|
Used by views that work with config context models (device and virtual machine).
|
|
Provides a get_queryset() method which deals with adding the config context
|
|
data annotation or not.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this virtual machine.
|
|
required: true
|
|
tags:
|
|
- virtualization
|
|
security:
|
|
- cookieAuth: []
|
|
- tokenAuth: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
components:
|
|
schemas:
|
|
AccessGrant:
|
|
type: object
|
|
description: API serializer for interacting with AccessGrant objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
command:
|
|
type: string
|
|
description: Enter <tt>*</tt> to grant access to all commands
|
|
maxLength: 64
|
|
subcommand:
|
|
type: string
|
|
description: Enter <tt>*</tt> to grant access to all subcommands of the
|
|
given command
|
|
maxLength: 64
|
|
grant_type:
|
|
$ref: '#/components/schemas/GrantTypeEnum'
|
|
name:
|
|
type: string
|
|
description: Organization name, channel name, or user name
|
|
maxLength: 255
|
|
value:
|
|
type: string
|
|
description: Corresponding ID value to grant access to.<br>Enter <tt>*</tt>
|
|
to grant access to all organizations, channels, or users
|
|
maxLength: 255
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- command
|
|
- display
|
|
- grant_type
|
|
- id
|
|
- name
|
|
- subcommand
|
|
- value
|
|
AccessTypeEnum:
|
|
enum:
|
|
- Generic
|
|
- Console
|
|
- gNMI
|
|
- HTTP(S)
|
|
- NETCONF
|
|
- REST
|
|
- RESTCONF
|
|
- SNMP
|
|
- SSH
|
|
type: string
|
|
Aggregate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: integer
|
|
enum:
|
|
- 4
|
|
- 6
|
|
label:
|
|
type: string
|
|
enum:
|
|
- IPv4
|
|
- IPv6
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
rir:
|
|
$ref: '#/components/schemas/NestedRIR'
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
date_added:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- family
|
|
- id
|
|
- last_updated
|
|
- prefix
|
|
- rir
|
|
- url
|
|
AvailableIP:
|
|
type: object
|
|
description: Representation of an IP address which does not exist in the database.
|
|
properties:
|
|
family:
|
|
type: integer
|
|
readOnly: true
|
|
address:
|
|
type: string
|
|
readOnly: true
|
|
vrf:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVRF'
|
|
readOnly: true
|
|
required:
|
|
- address
|
|
- family
|
|
- vrf
|
|
AvailablePrefix:
|
|
type: object
|
|
description: Representation of a prefix which does not exist in the database.
|
|
properties:
|
|
family:
|
|
type: integer
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
readOnly: true
|
|
vrf:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVRF'
|
|
readOnly: true
|
|
required:
|
|
- family
|
|
- prefix
|
|
- vrf
|
|
BlankEnum:
|
|
enum:
|
|
- ''
|
|
ButtonClassEnum:
|
|
enum:
|
|
- default
|
|
- primary
|
|
- success
|
|
- info
|
|
- warning
|
|
- danger
|
|
- link
|
|
type: string
|
|
CVELCM:
|
|
type: object
|
|
description: REST API serializer for CVELCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 16
|
|
published_date:
|
|
type: string
|
|
format: date
|
|
link:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum: []
|
|
label:
|
|
type: string
|
|
enum: []
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
severity:
|
|
type: string
|
|
maxLength: 50
|
|
cvss:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSS Base Score
|
|
cvss_v2:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSSv2 Score
|
|
cvss_v3:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSSv3 Score
|
|
fix:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
comments:
|
|
type: string
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- link
|
|
- name
|
|
- published_date
|
|
- url
|
|
Cable:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
termination_a_type:
|
|
type: string
|
|
termination_a_id:
|
|
type: string
|
|
format: uuid
|
|
termination_a:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
termination_b_type:
|
|
type: string
|
|
termination_b_id:
|
|
type: string
|
|
format: uuid
|
|
termination_b:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CableTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- connected
|
|
- decommissioning
|
|
- planned
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Connected
|
|
- Decommissioning
|
|
- Planned
|
|
label:
|
|
type: string
|
|
maxLength: 100
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
length:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
length_unit:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- m
|
|
- cm
|
|
- ft
|
|
- in
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Meters
|
|
- Centimeters
|
|
- Feet
|
|
- Inches
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- status
|
|
- termination_a
|
|
- termination_a_id
|
|
- termination_a_type
|
|
- termination_b
|
|
- termination_b_id
|
|
- termination_b_type
|
|
- url
|
|
CableTypeChoices:
|
|
enum:
|
|
- cat3
|
|
- cat5
|
|
- cat5e
|
|
- cat6
|
|
- cat6a
|
|
- cat7
|
|
- cat7a
|
|
- cat8
|
|
- dac-active
|
|
- dac-passive
|
|
- mrj21-trunk
|
|
- coaxial
|
|
- mmf
|
|
- mmf-om1
|
|
- mmf-om2
|
|
- mmf-om3
|
|
- mmf-om4
|
|
- smf
|
|
- smf-os1
|
|
- smf-os2
|
|
- aoc
|
|
- power
|
|
type: string
|
|
Circuit:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
cid:
|
|
type: string
|
|
title: Circuit ID
|
|
maxLength: 100
|
|
provider:
|
|
$ref: '#/components/schemas/NestedProvider'
|
|
type:
|
|
$ref: '#/components/schemas/NestedCircuitType'
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioned
|
|
- deprovisioning
|
|
- offline
|
|
- planned
|
|
- provisioning
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Decommissioned
|
|
- Deprovisioning
|
|
- Offline
|
|
- Planned
|
|
- Provisioning
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
install_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Date installed
|
|
commit_rate:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Commit rate (Kbps)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
termination_a:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CircuitCircuitTermination'
|
|
readOnly: true
|
|
termination_z:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CircuitCircuitTermination'
|
|
readOnly: true
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cid
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- provider
|
|
- status
|
|
- termination_a
|
|
- termination_z
|
|
- type
|
|
- url
|
|
CircuitCircuitTermination:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
$ref: '#/components/schemas/NestedSite'
|
|
provider_network:
|
|
$ref: '#/components/schemas/NestedProviderNetwork'
|
|
connected_endpoint:
|
|
$ref: '#/components/schemas/NestedInterface'
|
|
port_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Port speed (Kbps)
|
|
upstream_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Upstream speed (Kbps)
|
|
description: Upstream speed, if different from port speed
|
|
xconnect_id:
|
|
type: string
|
|
title: Cross-connect ID
|
|
maxLength: 50
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- connected_endpoint
|
|
- display
|
|
- id
|
|
- provider_network
|
|
- site
|
|
- url
|
|
CircuitMaintenance:
|
|
type: object
|
|
description: Serializer for API.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
start_time:
|
|
type: string
|
|
format: date-time
|
|
end_time:
|
|
type: string
|
|
format: date-time
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
status:
|
|
nullable: true
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CircuitMaintenanceStatusEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
- $ref: '#/components/schemas/NullEnum'
|
|
ack:
|
|
type: boolean
|
|
nullable: true
|
|
required:
|
|
- end_time
|
|
- id
|
|
- start_time
|
|
CircuitMaintenanceCircuitImpact:
|
|
type: object
|
|
description: Serializer for API.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
maintenance:
|
|
type: string
|
|
format: uuid
|
|
circuit:
|
|
type: string
|
|
format: uuid
|
|
impact:
|
|
nullable: true
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImpactEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
- $ref: '#/components/schemas/NullEnum'
|
|
required:
|
|
- circuit
|
|
- id
|
|
- maintenance
|
|
CircuitMaintenanceStatusEnum:
|
|
enum:
|
|
- TENTATIVE
|
|
- CONFIRMED
|
|
- CANCELLED
|
|
- IN-PROCESS
|
|
- COMPLETED
|
|
- RE-SCHEDULED
|
|
- UNKNOWN
|
|
type: string
|
|
CircuitTermination:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
circuit:
|
|
$ref: '#/components/schemas/NestedCircuit'
|
|
term_side:
|
|
allOf:
|
|
- $ref: '#/components/schemas/TermSideEnum'
|
|
title: Termination
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
nullable: true
|
|
provider_network:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedProviderNetwork'
|
|
nullable: true
|
|
port_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Port speed (Kbps)
|
|
upstream_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Upstream speed (Kbps)
|
|
description: Upstream speed, if different from port speed
|
|
xconnect_id:
|
|
type: string
|
|
title: Cross-connect ID
|
|
maxLength: 50
|
|
pp_info:
|
|
type: string
|
|
title: Patch panel/port(s)
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- circuit
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- display
|
|
- id
|
|
- term_side
|
|
- url
|
|
CircuitType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
Cluster:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
type:
|
|
$ref: '#/components/schemas/NestedClusterType'
|
|
group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedClusterGroup'
|
|
nullable: true
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- type
|
|
- url
|
|
- virtualmachine_count
|
|
ClusterGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster_count
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
ClusterType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster_count
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
CommandToken:
|
|
type: object
|
|
description: API serializer for interacting with CommandToken objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
comment:
|
|
type: string
|
|
description: 'Optional: Enter description of token'
|
|
maxLength: 255
|
|
platform:
|
|
$ref: '#/components/schemas/PlatformEnum'
|
|
token:
|
|
type: string
|
|
description: Token given by chat platform for signing or command validation
|
|
maxLength: 255
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- platform
|
|
- token
|
|
ComplianceFeature:
|
|
type: object
|
|
description: Serializer for ComplianceFeature object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- slug
|
|
- url
|
|
ComplianceRule:
|
|
type: object
|
|
description: Serializer for ComplianceRule object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
config_ordered:
|
|
type: boolean
|
|
title: Configured Ordered
|
|
description: Whether or not the configuration order matters, such as in
|
|
ACLs.
|
|
match_config:
|
|
type: string
|
|
nullable: true
|
|
title: Config to Match
|
|
description: The config to match that is matched based on the parent most
|
|
configuration. e.g. `router bgp` or `ntp`.
|
|
config_type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ConfigTypeEnum'
|
|
description: Whether the config is in cli or json/structured format.
|
|
feature:
|
|
type: string
|
|
format: uuid
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
required:
|
|
- computed_fields
|
|
- config_ordered
|
|
- created
|
|
- display
|
|
- feature
|
|
- id
|
|
- last_updated
|
|
- platform
|
|
- url
|
|
ComputedField:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
slug:
|
|
type: string
|
|
description: Internal field name
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
label:
|
|
type: string
|
|
description: Name of the field as displayed to users
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
content_type:
|
|
type: string
|
|
template:
|
|
type: string
|
|
description: Jinja2 template code for field value
|
|
maxLength: 500
|
|
fallback_value:
|
|
type: string
|
|
description: Fallback value (if any) to be output for the field in the case
|
|
of a template rendering error.
|
|
maxLength: 500
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- display
|
|
- id
|
|
- label
|
|
- template
|
|
- url
|
|
ConfigCompliance:
|
|
type: object
|
|
description: Serializer for ConfigCompliance object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
compliance:
|
|
type: boolean
|
|
nullable: true
|
|
actual:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Actual Configuration for feature
|
|
intended:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Intended Configuration for feature
|
|
missing:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Configuration that should be on the device.
|
|
extra:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Configuration that should not be on the device.
|
|
ordered:
|
|
type: boolean
|
|
compliance_int:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: -2147483648
|
|
nullable: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
description: The device
|
|
rule:
|
|
type: string
|
|
format: uuid
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- rule
|
|
ConfigContext:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedConfigContextSchema'
|
|
nullable: true
|
|
is_active:
|
|
type: boolean
|
|
regions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- display
|
|
- id
|
|
- name
|
|
- site_count
|
|
- url
|
|
sites:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
roles:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
manufacturer:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedManufacturer'
|
|
readOnly: true
|
|
model:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- manufacturer
|
|
- model
|
|
- slug
|
|
- url
|
|
platforms:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
cluster_groups:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
clusters:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
tenant_groups:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
tenant_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- display
|
|
- id
|
|
- name
|
|
- tenant_count
|
|
- url
|
|
tenants:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- data
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- owner
|
|
- url
|
|
ConfigContextSchema:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 200
|
|
slug:
|
|
type: string
|
|
maxLength: 200
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
data_schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: A JSON Schema document which is used to validate a config context
|
|
object.
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- data_schema
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- owner
|
|
- url
|
|
ConfigRemove:
|
|
type: object
|
|
description: Serializer for ConfigRemove object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
regex:
|
|
type: string
|
|
title: Regex Pattern
|
|
description: Regex pattern used to remove a line from the backup configuration.
|
|
maxLength: 200
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- platform
|
|
- regex
|
|
- url
|
|
ConfigReplace:
|
|
type: object
|
|
description: Serializer for ConfigReplace object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
regex:
|
|
type: string
|
|
title: Regex Pattern to Substitute
|
|
description: Regex pattern that will be found and replaced with 'replaced
|
|
text'.
|
|
maxLength: 200
|
|
replace:
|
|
type: string
|
|
title: Replaced Text
|
|
description: Text that will be inserted in place of Regex pattern match.
|
|
maxLength: 200
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- platform
|
|
- regex
|
|
- replace
|
|
- url
|
|
ConfigTypeEnum:
|
|
enum:
|
|
- cli
|
|
- json
|
|
- custom
|
|
type: string
|
|
ConsolePort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- de-9
|
|
- db-25
|
|
- rj-11
|
|
- rj-12
|
|
- rj-45
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- other
|
|
label:
|
|
type: string
|
|
enum:
|
|
- DE-9
|
|
- DB-25
|
|
- RJ-11
|
|
- RJ-12
|
|
- RJ-45
|
|
- USB Type A
|
|
- USB Type B
|
|
- USB Type C
|
|
- USB Mini A
|
|
- USB Mini B
|
|
- USB Micro A
|
|
- USB Micro B
|
|
- Other
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
ConsolePortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- de-9
|
|
- db-25
|
|
- rj-11
|
|
- rj-12
|
|
- rj-45
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- other
|
|
label:
|
|
type: string
|
|
enum:
|
|
- DE-9
|
|
- DB-25
|
|
- RJ-11
|
|
- RJ-12
|
|
- RJ-45
|
|
- USB Type A
|
|
- USB Type B
|
|
- USB Type C
|
|
- USB Mini A
|
|
- USB Mini B
|
|
- USB Micro A
|
|
- USB Micro B
|
|
- Other
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
ConsolePortTypeChoices:
|
|
enum:
|
|
- de-9
|
|
- db-25
|
|
- rj-11
|
|
- rj-12
|
|
- rj-45
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- other
|
|
type: string
|
|
ConsoleServerPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- de-9
|
|
- db-25
|
|
- rj-11
|
|
- rj-12
|
|
- rj-45
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- other
|
|
label:
|
|
type: string
|
|
enum:
|
|
- DE-9
|
|
- DB-25
|
|
- RJ-11
|
|
- RJ-12
|
|
- RJ-45
|
|
- USB Type A
|
|
- USB Type B
|
|
- USB Type C
|
|
- USB Mini A
|
|
- USB Mini B
|
|
- USB Micro A
|
|
- USB Micro B
|
|
- Other
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
ConsoleServerPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- de-9
|
|
- db-25
|
|
- rj-11
|
|
- rj-12
|
|
- rj-45
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- other
|
|
label:
|
|
type: string
|
|
enum:
|
|
- DE-9
|
|
- DB-25
|
|
- RJ-11
|
|
- RJ-12
|
|
- RJ-45
|
|
- USB Type A
|
|
- USB Type B
|
|
- USB Type C
|
|
- USB Mini A
|
|
- USB Mini B
|
|
- USB Micro A
|
|
- USB Micro B
|
|
- Other
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
ContactLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 80
|
|
address:
|
|
type: string
|
|
maxLength: 200
|
|
phone:
|
|
type: string
|
|
maxLength: 20
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: Contact E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
priority:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
contract:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedContractLCM'
|
|
description: Associated Contract
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- contract
|
|
- display
|
|
- name
|
|
ContentType:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
app_label:
|
|
type: string
|
|
maxLength: 100
|
|
model:
|
|
type: string
|
|
title: Python model class name
|
|
maxLength: 100
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
required:
|
|
- app_label
|
|
- display
|
|
- id
|
|
- model
|
|
- url
|
|
ContractLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
provider:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedProviderLCM'
|
|
description: Vendor
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
start:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract Start Date
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract End Date
|
|
cost:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
|
|
nullable: true
|
|
title: Contract Cost
|
|
support_level:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
contract_type:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 32
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- expired
|
|
- id
|
|
- name
|
|
- provider
|
|
CustomField:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- text
|
|
- integer
|
|
- boolean
|
|
- date
|
|
- url
|
|
- select
|
|
- multi-select
|
|
- json
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Text
|
|
- Integer
|
|
- Boolean (true/false)
|
|
- Date
|
|
- URL
|
|
- Selection
|
|
- Multiple selection
|
|
- JSON
|
|
name:
|
|
type: string
|
|
title: Slug
|
|
description: URL-friendly unique shorthand.
|
|
maxLength: 50
|
|
label:
|
|
type: string
|
|
description: Name of the field as displayed to users (if not provided, the
|
|
field's slug will be used.)
|
|
maxLength: 50
|
|
description:
|
|
type: string
|
|
description: A helpful description for this field.
|
|
maxLength: 200
|
|
required:
|
|
type: boolean
|
|
description: If true, this field is required when creating new objects or
|
|
editing an existing object.
|
|
filter_logic:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- disabled
|
|
- loose
|
|
- exact
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Disabled
|
|
- Loose
|
|
- Exact
|
|
default:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Default value for the field (must be a JSON value). Encapsulate
|
|
strings with double quotes (e.g. "Foo").
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description: Fields with higher weights appear lower in a form.
|
|
validation_minimum:
|
|
type: integer
|
|
maximum: 9223372036854775807
|
|
minimum: -9223372036854775808
|
|
format: int64
|
|
nullable: true
|
|
title: Minimum value
|
|
description: Minimum allowed value (for numeric fields).
|
|
validation_maximum:
|
|
type: integer
|
|
maximum: 9223372036854775807
|
|
minimum: -9223372036854775808
|
|
format: int64
|
|
nullable: true
|
|
title: Maximum value
|
|
description: Maximum allowed value (for numeric fields).
|
|
validation_regex:
|
|
type: string
|
|
description: Regular expression to enforce on text field values. Use ^ and
|
|
$ to force matching of entire string. For example, <code>^[A-Z]{3}$</code>
|
|
will limit values to exactly three uppercase letters. Regular expression
|
|
on select and multi-select will be applied at <code>Custom Field Choices</code>
|
|
definition.
|
|
maxLength: 500
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_types
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
CustomFieldChoice:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
field:
|
|
$ref: '#/components/schemas/NestedCustomField'
|
|
value:
|
|
type: string
|
|
maxLength: 100
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description: Higher weights appear later in the list
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- field
|
|
- id
|
|
- url
|
|
- value
|
|
CustomFieldTypeChoices:
|
|
enum:
|
|
- text
|
|
- integer
|
|
- boolean
|
|
- date
|
|
- url
|
|
- select
|
|
- multi-select
|
|
- json
|
|
type: string
|
|
CustomLink:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
target_url:
|
|
type: string
|
|
title: URL
|
|
description: Jinja2 template code for link URL. Reference the object as
|
|
<code>{{ obj }}</code> such as <code>{{ obj.platform.slug }}</code>.
|
|
maxLength: 500
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
content_type:
|
|
type: string
|
|
text:
|
|
type: string
|
|
description: Jinja2 template code for link text. Reference the object as
|
|
<code>{{ obj }}</code> such as <code>{{ obj.platform.slug }}</code>. Links
|
|
which render as empty text will not be displayed.
|
|
maxLength: 500
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
group_name:
|
|
type: string
|
|
description: Links with the same group will appear as a dropdown menu
|
|
maxLength: 50
|
|
button_class:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ButtonClassEnum'
|
|
description: The class of the first link in a group will be used for the
|
|
dropdown button
|
|
new_window:
|
|
type: boolean
|
|
description: Force link to open in a new window
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- display
|
|
- id
|
|
- name
|
|
- new_window
|
|
- target_url
|
|
- text
|
|
- url
|
|
Device:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
device_role:
|
|
$ref: '#/components/schemas/NestedDeviceRole'
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
platform:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedPlatform'
|
|
nullable: true
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this device
|
|
maxLength: 50
|
|
site:
|
|
$ref: '#/components/schemas/NestedSite'
|
|
rack:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRack'
|
|
nullable: true
|
|
position:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
title: Position (U)
|
|
description: The lowest-numbered unit occupied by the device
|
|
face:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- front
|
|
- rear
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Front
|
|
- Rear
|
|
parent_device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- failed
|
|
- inventory
|
|
- offline
|
|
- planned
|
|
- staged
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Decommissioning
|
|
- Failed
|
|
- Inventory
|
|
- Offline
|
|
- Planned
|
|
- Staged
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
primary_ip6:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
secrets_group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSecretsGroup'
|
|
nullable: true
|
|
cluster:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCluster'
|
|
nullable: true
|
|
virtual_chassis:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVirtualChassis'
|
|
nullable: true
|
|
vc_position:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
vc_priority:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
local_context_schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedConfigContextSchema'
|
|
nullable: true
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device_role
|
|
- device_type
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- parent_device
|
|
- primary_ip
|
|
- site
|
|
- status
|
|
- url
|
|
DeviceBay:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
installed_device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
DeviceBayTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
DeviceNAPALM:
|
|
type: object
|
|
properties:
|
|
method:
|
|
type: object
|
|
additionalProperties: {}
|
|
required:
|
|
- method
|
|
DeviceRole:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
vm_role:
|
|
type: boolean
|
|
description: Virtual machines may be assigned to this role
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
DeviceType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
manufacturer:
|
|
$ref: '#/components/schemas/NestedManufacturer'
|
|
model:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
part_number:
|
|
type: string
|
|
description: Discrete part number (optional)
|
|
maxLength: 50
|
|
u_height:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
title: Height (U)
|
|
is_full_depth:
|
|
type: boolean
|
|
description: Device consumes both front and rear rack faces
|
|
subdevice_role:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- parent
|
|
- child
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Parent
|
|
- Child
|
|
front_image:
|
|
type: string
|
|
format: uri
|
|
rear_image:
|
|
type: string
|
|
format: uri
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- manufacturer
|
|
- model
|
|
- url
|
|
DeviceWithConfigContext:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
device_role:
|
|
$ref: '#/components/schemas/NestedDeviceRole'
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
platform:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedPlatform'
|
|
nullable: true
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this device
|
|
maxLength: 50
|
|
site:
|
|
$ref: '#/components/schemas/NestedSite'
|
|
rack:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRack'
|
|
nullable: true
|
|
position:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
title: Position (U)
|
|
description: The lowest-numbered unit occupied by the device
|
|
face:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- front
|
|
- rear
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Front
|
|
- Rear
|
|
parent_device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- failed
|
|
- inventory
|
|
- offline
|
|
- planned
|
|
- staged
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Decommissioning
|
|
- Failed
|
|
- Inventory
|
|
- Offline
|
|
- Planned
|
|
- Staged
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
primary_ip6:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
secrets_group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSecretsGroup'
|
|
nullable: true
|
|
cluster:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCluster'
|
|
nullable: true
|
|
virtual_chassis:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVirtualChassis'
|
|
nullable: true
|
|
vc_position:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
vc_priority:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
local_context_schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedConfigContextSchema'
|
|
nullable: true
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
config_context:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- config_context
|
|
- created
|
|
- device_role
|
|
- device_type
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- parent_device
|
|
- primary_ip
|
|
- site
|
|
- status
|
|
- url
|
|
DynamicGroup:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Dynamic Group name
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
description: Unique slug
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
content_type:
|
|
type: string
|
|
filter:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: A JSON-encoded dictionary of filter parameters for group membership
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- display
|
|
- filter
|
|
- id
|
|
- name
|
|
- url
|
|
ExportTemplate:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_type:
|
|
type: string
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
template_code:
|
|
type: string
|
|
description: The list of objects being exported is passed as a context variable
|
|
named <code>queryset</code>.
|
|
mime_type:
|
|
type: string
|
|
description: Defaults to <code>text/plain</code>
|
|
maxLength: 50
|
|
file_extension:
|
|
type: string
|
|
description: Extension to append to the rendered filename
|
|
maxLength: 15
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- display
|
|
- id
|
|
- name
|
|
- owner
|
|
- template_code
|
|
- url
|
|
FaceEnum:
|
|
enum:
|
|
- front
|
|
- rear
|
|
type: string
|
|
FamilyEnum:
|
|
type: integer
|
|
enum:
|
|
- 4
|
|
- 6
|
|
FeedLegEnum:
|
|
enum:
|
|
- A
|
|
- B
|
|
- C
|
|
type: string
|
|
FilterLogicEnum:
|
|
enum:
|
|
- disabled
|
|
- loose
|
|
- exact
|
|
type: string
|
|
FrontPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- 8p8c
|
|
- 8p6c
|
|
- 8p4c
|
|
- 8p2c
|
|
- gg45
|
|
- tera-4p
|
|
- tera-2p
|
|
- tera-1p
|
|
- 110-punch
|
|
- bnc
|
|
- mrj21
|
|
- fc
|
|
- lc
|
|
- lc-apc
|
|
- lsh
|
|
- lsh-apc
|
|
- mpo
|
|
- mtrj
|
|
- sc
|
|
- sc-apc
|
|
- st
|
|
- cs
|
|
- sn
|
|
- urm-p2
|
|
- urm-p4
|
|
- urm-p8
|
|
- splice
|
|
label:
|
|
type: string
|
|
enum:
|
|
- 8P8C
|
|
- 8P6C
|
|
- 8P4C
|
|
- 8P2C
|
|
- GG45
|
|
- TERA 4P
|
|
- TERA 2P
|
|
- TERA 1P
|
|
- 110 Punch
|
|
- BNC
|
|
- MRJ21
|
|
- FC
|
|
- LC
|
|
- LC/APC
|
|
- LSH
|
|
- LSH/APC
|
|
- MPO
|
|
- MTRJ
|
|
- SC
|
|
- SC/APC
|
|
- ST
|
|
- CS
|
|
- SN
|
|
- URM-P2
|
|
- URM-P4
|
|
- URM-P8
|
|
- Splice
|
|
rear_port:
|
|
$ref: '#/components/schemas/FrontPortRearPort'
|
|
rear_port_position:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
default: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- rear_port
|
|
- type
|
|
- url
|
|
FrontPortRearPort:
|
|
type: object
|
|
description: NestedRearPortSerializer but with parent device omitted (since
|
|
front and rear ports must belong to same device)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
FrontPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- 8p8c
|
|
- 8p6c
|
|
- 8p4c
|
|
- 8p2c
|
|
- gg45
|
|
- tera-4p
|
|
- tera-2p
|
|
- tera-1p
|
|
- 110-punch
|
|
- bnc
|
|
- mrj21
|
|
- fc
|
|
- lc
|
|
- lc-apc
|
|
- lsh
|
|
- lsh-apc
|
|
- mpo
|
|
- mtrj
|
|
- sc
|
|
- sc-apc
|
|
- st
|
|
- cs
|
|
- sn
|
|
- urm-p2
|
|
- urm-p4
|
|
- urm-p8
|
|
- splice
|
|
label:
|
|
type: string
|
|
enum:
|
|
- 8P8C
|
|
- 8P6C
|
|
- 8P4C
|
|
- 8P2C
|
|
- GG45
|
|
- TERA 4P
|
|
- TERA 2P
|
|
- TERA 1P
|
|
- 110 Punch
|
|
- BNC
|
|
- MRJ21
|
|
- FC
|
|
- LC
|
|
- LC/APC
|
|
- LSH
|
|
- LSH/APC
|
|
- MPO
|
|
- MTRJ
|
|
- SC
|
|
- SC/APC
|
|
- ST
|
|
- CS
|
|
- SN
|
|
- URM-P2
|
|
- URM-P4
|
|
- URM-P8
|
|
- Splice
|
|
rear_port:
|
|
$ref: '#/components/schemas/NestedRearPortTemplate'
|
|
rear_port_position:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
default: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- rear_port
|
|
- type
|
|
- url
|
|
GitRepository:
|
|
type: object
|
|
description: Git repositories defined as a data source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
remote_url:
|
|
type: string
|
|
format: uri
|
|
description: Only HTTP and HTTPS URLs are presently supported
|
|
maxLength: 255
|
|
branch:
|
|
type: string
|
|
maxLength: 64
|
|
token:
|
|
type: string
|
|
writeOnly: true
|
|
username:
|
|
type: string
|
|
maxLength: 64
|
|
secrets_group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSecretsGroup'
|
|
nullable: true
|
|
current_head:
|
|
type: string
|
|
description: Commit hash of the most recent fetch from the selected branch.
|
|
Used for syncing between workers.
|
|
maxLength: 48
|
|
provided_contents:
|
|
type: array
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ProvidedContentsEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- remote_url
|
|
- url
|
|
GoldenConfig:
|
|
type: object
|
|
description: Serializer for GoldenConfig object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
backup_config:
|
|
type: string
|
|
description: Full backup config for device.
|
|
backup_last_attempt_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
backup_last_success_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
intended_config:
|
|
type: string
|
|
description: Intended config for the device.
|
|
intended_last_attempt_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
intended_last_success_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
compliance_config:
|
|
type: string
|
|
description: Full config diff for device.
|
|
compliance_last_attempt_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
compliance_last_success_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
description: device
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- url
|
|
GoldenConfigSetting:
|
|
type: object
|
|
description: Serializer for GoldenConfigSetting object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
backup_path_template:
|
|
type: string
|
|
title: Backup Path in Jinja Template Form
|
|
description: The Jinja path representation of where the backup file will
|
|
be found. The variable `obj` is available as the device instance object
|
|
of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg`
|
|
maxLength: 255
|
|
intended_path_template:
|
|
type: string
|
|
title: Intended Path in Jinja Template Form
|
|
description: The Jinja path representation of where the generated file will
|
|
be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg`
|
|
maxLength: 255
|
|
jinja_path_template:
|
|
type: string
|
|
title: Template Path in Jinja Template Form
|
|
description: The Jinja path representation of where the Jinja template can
|
|
be found. e.g. `{{obj.platform.slug}}.j2`
|
|
maxLength: 255
|
|
backup_test_connectivity:
|
|
type: boolean
|
|
title: Backup Test
|
|
description: Whether or not to pretest the connectivity of the device by
|
|
verifying there is a resolvable IP that can connect to port 22.
|
|
scope:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: API filter in JSON format matching the list of devices for
|
|
the scope of devices to be considered.
|
|
backup_repository:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
intended_repository:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
jinja_repository:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
sot_agg_query:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- slug
|
|
- url
|
|
GrantTypeEnum:
|
|
enum:
|
|
- organization
|
|
- channel
|
|
- user
|
|
type: string
|
|
GraphQLAPI:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: GraphQL query
|
|
variables:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Variables in JSON Format
|
|
required:
|
|
- query
|
|
GraphQLQuery:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
query:
|
|
type: string
|
|
variables:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
default: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- query
|
|
- url
|
|
GraphQLQueryInput:
|
|
type: object
|
|
properties:
|
|
variables:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
default: {}
|
|
GraphQLQueryOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
default: {}
|
|
Group:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: integer
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 150
|
|
user_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- user_count
|
|
HardwareLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
devices:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
description: Devices tied to Device Type
|
|
device_type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDeviceType'
|
|
description: Device Type to attach the Hardware LCM to
|
|
inventory_item:
|
|
type: string
|
|
nullable: true
|
|
title: Inventory Item Part
|
|
maxLength: 255
|
|
release_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_sale:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_sw_releases:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Releases
|
|
end_of_security_patches:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
documentation_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- devices
|
|
- display
|
|
- expired
|
|
- id
|
|
HttpMethodEnum:
|
|
enum:
|
|
- GET
|
|
- POST
|
|
- PUT
|
|
- PATCH
|
|
- DELETE
|
|
type: string
|
|
IPAddress:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: integer
|
|
enum:
|
|
- 4
|
|
- 6
|
|
label:
|
|
type: string
|
|
enum:
|
|
- IPv4
|
|
- IPv6
|
|
readOnly: true
|
|
address:
|
|
type: string
|
|
vrf:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVRF'
|
|
nullable: true
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- deprecated
|
|
- dhcp
|
|
- reserved
|
|
- slaac
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Deprecated
|
|
- DHCP
|
|
- Reserved
|
|
- SLAAC
|
|
role:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- loopback
|
|
- secondary
|
|
- anycast
|
|
- vip
|
|
- vrrp
|
|
- hsrp
|
|
- glbp
|
|
- carp
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Loopback
|
|
- Secondary
|
|
- Anycast
|
|
- VIP
|
|
- VRRP
|
|
- HSRP
|
|
- GLBP
|
|
- CARP
|
|
assigned_object_type:
|
|
type: string
|
|
nullable: true
|
|
assigned_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
assigned_object:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
nat_inside:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
nat_outside:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
dns_name:
|
|
type: string
|
|
description: Hostname or FQDN (not case-sensitive)
|
|
pattern: ^[0-9A-Za-z._-]+$
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- address
|
|
- assigned_object
|
|
- created
|
|
- display
|
|
- family
|
|
- id
|
|
- last_updated
|
|
- nat_outside
|
|
- status
|
|
- url
|
|
ImageAttachment:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_type:
|
|
type: string
|
|
object_id:
|
|
type: string
|
|
format: uuid
|
|
parent:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 50
|
|
image:
|
|
type: string
|
|
format: uri
|
|
image_height:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
image_width:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- created
|
|
- display
|
|
- id
|
|
- image
|
|
- image_height
|
|
- image_width
|
|
- object_id
|
|
- parent
|
|
- url
|
|
ImpactEnum:
|
|
enum:
|
|
- NO-IMPACT
|
|
- REDUCED-REDUNDANCY
|
|
- DEGRADED
|
|
- OUTAGE
|
|
type: string
|
|
Interface:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- virtual
|
|
- lag
|
|
- 100base-tx
|
|
- 1000base-t
|
|
- 2.5gbase-t
|
|
- 5gbase-t
|
|
- 10gbase-t
|
|
- 10gbase-cx4
|
|
- 1000base-x-gbic
|
|
- 1000base-x-sfp
|
|
- 10gbase-x-sfpp
|
|
- 10gbase-x-xfp
|
|
- 10gbase-x-xenpak
|
|
- 10gbase-x-x2
|
|
- 25gbase-x-sfp28
|
|
- 40gbase-x-qsfpp
|
|
- 50gbase-x-sfp28
|
|
- 100gbase-x-cfp
|
|
- 100gbase-x-cfp2
|
|
- 200gbase-x-cfp2
|
|
- 100gbase-x-cfp4
|
|
- 100gbase-x-cpak
|
|
- 100gbase-x-qsfp28
|
|
- 200gbase-x-qsfp56
|
|
- 400gbase-x-qsfpdd
|
|
- 400gbase-x-osfp
|
|
- ieee802.11a
|
|
- ieee802.11g
|
|
- ieee802.11n
|
|
- ieee802.11ac
|
|
- ieee802.11ad
|
|
- ieee802.11ax
|
|
- gsm
|
|
- cdma
|
|
- lte
|
|
- sonet-oc3
|
|
- sonet-oc12
|
|
- sonet-oc48
|
|
- sonet-oc192
|
|
- sonet-oc768
|
|
- sonet-oc1920
|
|
- sonet-oc3840
|
|
- 1gfc-sfp
|
|
- 2gfc-sfp
|
|
- 4gfc-sfp
|
|
- 8gfc-sfpp
|
|
- 16gfc-sfpp
|
|
- 32gfc-sfp28
|
|
- 64gfc-qsfpp
|
|
- 128gfc-sfp28
|
|
- infiniband-sdr
|
|
- infiniband-ddr
|
|
- infiniband-qdr
|
|
- infiniband-fdr10
|
|
- infiniband-fdr
|
|
- infiniband-edr
|
|
- infiniband-hdr
|
|
- infiniband-ndr
|
|
- infiniband-xdr
|
|
- t1
|
|
- e1
|
|
- t3
|
|
- e3
|
|
- cisco-stackwise
|
|
- cisco-stackwise-plus
|
|
- cisco-flexstack
|
|
- cisco-flexstack-plus
|
|
- juniper-vcp
|
|
- extreme-summitstack
|
|
- extreme-summitstack-128
|
|
- extreme-summitstack-256
|
|
- extreme-summitstack-512
|
|
- other
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Virtual
|
|
- Link Aggregation Group (LAG)
|
|
- 100BASE-TX (10/100ME)
|
|
- 1000BASE-T (1GE)
|
|
- 2.5GBASE-T (2.5GE)
|
|
- 5GBASE-T (5GE)
|
|
- 10GBASE-T (10GE)
|
|
- 10GBASE-CX4 (10GE)
|
|
- GBIC (1GE)
|
|
- SFP (1GE)
|
|
- SFP+ (10GE)
|
|
- XFP (10GE)
|
|
- XENPAK (10GE)
|
|
- X2 (10GE)
|
|
- SFP28 (25GE)
|
|
- QSFP+ (40GE)
|
|
- QSFP28 (50GE)
|
|
- CFP (100GE)
|
|
- CFP2 (100GE)
|
|
- CFP2 (200GE)
|
|
- CFP4 (100GE)
|
|
- Cisco CPAK (100GE)
|
|
- QSFP28 (100GE)
|
|
- QSFP56 (200GE)
|
|
- QSFP-DD (400GE)
|
|
- OSFP (400GE)
|
|
- IEEE 802.11a
|
|
- IEEE 802.11b/g
|
|
- IEEE 802.11n
|
|
- IEEE 802.11ac
|
|
- IEEE 802.11ad
|
|
- IEEE 802.11ax
|
|
- GSM
|
|
- CDMA
|
|
- LTE
|
|
- OC-3/STM-1
|
|
- OC-12/STM-4
|
|
- OC-48/STM-16
|
|
- OC-192/STM-64
|
|
- OC-768/STM-256
|
|
- OC-1920/STM-640
|
|
- OC-3840/STM-1234
|
|
- SFP (1GFC)
|
|
- SFP (2GFC)
|
|
- SFP (4GFC)
|
|
- SFP+ (8GFC)
|
|
- SFP+ (16GFC)
|
|
- SFP28 (32GFC)
|
|
- 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)
|
|
- Cisco StackWise
|
|
- Cisco StackWise Plus
|
|
- Cisco FlexStack
|
|
- Cisco FlexStack Plus
|
|
- Juniper VCP
|
|
- Extreme SummitStack
|
|
- Extreme SummitStack-128
|
|
- Extreme SummitStack-256
|
|
- Extreme SummitStack-512
|
|
- Other
|
|
enabled:
|
|
type: boolean
|
|
lag:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedInterface'
|
|
nullable: true
|
|
mtu:
|
|
type: integer
|
|
maximum: 65536
|
|
minimum: 1
|
|
nullable: true
|
|
mac_address:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 18
|
|
mgmt_only:
|
|
type: boolean
|
|
title: Management only
|
|
description: This interface is used only for out-of-band management
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
mode:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- access
|
|
- tagged
|
|
- tagged-all
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Access
|
|
- Tagged
|
|
- Tagged (All)
|
|
untagged_vlan:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVLAN'
|
|
nullable: true
|
|
tagged_vlans:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
vid:
|
|
type: integer
|
|
maximum: 4094
|
|
minimum: 1
|
|
title: ID
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- vid
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
count_ipaddresses:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- count_ipaddresses
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
InterfaceConnection:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
interface_a:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedInterface'
|
|
readOnly: true
|
|
interface_b:
|
|
$ref: '#/components/schemas/NestedInterface'
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- connected_endpoint_reachable
|
|
- display
|
|
- interface_a
|
|
- interface_b
|
|
InterfaceTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- virtual
|
|
- lag
|
|
- 100base-tx
|
|
- 1000base-t
|
|
- 2.5gbase-t
|
|
- 5gbase-t
|
|
- 10gbase-t
|
|
- 10gbase-cx4
|
|
- 1000base-x-gbic
|
|
- 1000base-x-sfp
|
|
- 10gbase-x-sfpp
|
|
- 10gbase-x-xfp
|
|
- 10gbase-x-xenpak
|
|
- 10gbase-x-x2
|
|
- 25gbase-x-sfp28
|
|
- 40gbase-x-qsfpp
|
|
- 50gbase-x-sfp28
|
|
- 100gbase-x-cfp
|
|
- 100gbase-x-cfp2
|
|
- 200gbase-x-cfp2
|
|
- 100gbase-x-cfp4
|
|
- 100gbase-x-cpak
|
|
- 100gbase-x-qsfp28
|
|
- 200gbase-x-qsfp56
|
|
- 400gbase-x-qsfpdd
|
|
- 400gbase-x-osfp
|
|
- ieee802.11a
|
|
- ieee802.11g
|
|
- ieee802.11n
|
|
- ieee802.11ac
|
|
- ieee802.11ad
|
|
- ieee802.11ax
|
|
- gsm
|
|
- cdma
|
|
- lte
|
|
- sonet-oc3
|
|
- sonet-oc12
|
|
- sonet-oc48
|
|
- sonet-oc192
|
|
- sonet-oc768
|
|
- sonet-oc1920
|
|
- sonet-oc3840
|
|
- 1gfc-sfp
|
|
- 2gfc-sfp
|
|
- 4gfc-sfp
|
|
- 8gfc-sfpp
|
|
- 16gfc-sfpp
|
|
- 32gfc-sfp28
|
|
- 64gfc-qsfpp
|
|
- 128gfc-sfp28
|
|
- infiniband-sdr
|
|
- infiniband-ddr
|
|
- infiniband-qdr
|
|
- infiniband-fdr10
|
|
- infiniband-fdr
|
|
- infiniband-edr
|
|
- infiniband-hdr
|
|
- infiniband-ndr
|
|
- infiniband-xdr
|
|
- t1
|
|
- e1
|
|
- t3
|
|
- e3
|
|
- cisco-stackwise
|
|
- cisco-stackwise-plus
|
|
- cisco-flexstack
|
|
- cisco-flexstack-plus
|
|
- juniper-vcp
|
|
- extreme-summitstack
|
|
- extreme-summitstack-128
|
|
- extreme-summitstack-256
|
|
- extreme-summitstack-512
|
|
- other
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Virtual
|
|
- Link Aggregation Group (LAG)
|
|
- 100BASE-TX (10/100ME)
|
|
- 1000BASE-T (1GE)
|
|
- 2.5GBASE-T (2.5GE)
|
|
- 5GBASE-T (5GE)
|
|
- 10GBASE-T (10GE)
|
|
- 10GBASE-CX4 (10GE)
|
|
- GBIC (1GE)
|
|
- SFP (1GE)
|
|
- SFP+ (10GE)
|
|
- XFP (10GE)
|
|
- XENPAK (10GE)
|
|
- X2 (10GE)
|
|
- SFP28 (25GE)
|
|
- QSFP+ (40GE)
|
|
- QSFP28 (50GE)
|
|
- CFP (100GE)
|
|
- CFP2 (100GE)
|
|
- CFP2 (200GE)
|
|
- CFP4 (100GE)
|
|
- Cisco CPAK (100GE)
|
|
- QSFP28 (100GE)
|
|
- QSFP56 (200GE)
|
|
- QSFP-DD (400GE)
|
|
- OSFP (400GE)
|
|
- IEEE 802.11a
|
|
- IEEE 802.11b/g
|
|
- IEEE 802.11n
|
|
- IEEE 802.11ac
|
|
- IEEE 802.11ad
|
|
- IEEE 802.11ax
|
|
- GSM
|
|
- CDMA
|
|
- LTE
|
|
- OC-3/STM-1
|
|
- OC-12/STM-4
|
|
- OC-48/STM-16
|
|
- OC-192/STM-64
|
|
- OC-768/STM-256
|
|
- OC-1920/STM-640
|
|
- OC-3840/STM-1234
|
|
- SFP (1GFC)
|
|
- SFP (2GFC)
|
|
- SFP (4GFC)
|
|
- SFP+ (8GFC)
|
|
- SFP+ (16GFC)
|
|
- SFP28 (32GFC)
|
|
- 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)
|
|
- Cisco StackWise
|
|
- Cisco StackWise Plus
|
|
- Cisco FlexStack
|
|
- Cisco FlexStack Plus
|
|
- Juniper VCP
|
|
- Extreme SummitStack
|
|
- Extreme SummitStack-128
|
|
- Extreme SummitStack-256
|
|
- Extreme SummitStack-512
|
|
- Other
|
|
mgmt_only:
|
|
type: boolean
|
|
title: Management only
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
InterfaceTypeChoices:
|
|
enum:
|
|
- virtual
|
|
- lag
|
|
- 100base-tx
|
|
- 1000base-t
|
|
- 2.5gbase-t
|
|
- 5gbase-t
|
|
- 10gbase-t
|
|
- 10gbase-cx4
|
|
- 1000base-x-gbic
|
|
- 1000base-x-sfp
|
|
- 10gbase-x-sfpp
|
|
- 10gbase-x-xfp
|
|
- 10gbase-x-xenpak
|
|
- 10gbase-x-x2
|
|
- 25gbase-x-sfp28
|
|
- 40gbase-x-qsfpp
|
|
- 50gbase-x-sfp28
|
|
- 100gbase-x-cfp
|
|
- 100gbase-x-cfp2
|
|
- 200gbase-x-cfp2
|
|
- 100gbase-x-cfp4
|
|
- 100gbase-x-cpak
|
|
- 100gbase-x-qsfp28
|
|
- 200gbase-x-qsfp56
|
|
- 400gbase-x-qsfpdd
|
|
- 400gbase-x-osfp
|
|
- ieee802.11a
|
|
- ieee802.11g
|
|
- ieee802.11n
|
|
- ieee802.11ac
|
|
- ieee802.11ad
|
|
- ieee802.11ax
|
|
- gsm
|
|
- cdma
|
|
- lte
|
|
- sonet-oc3
|
|
- sonet-oc12
|
|
- sonet-oc48
|
|
- sonet-oc192
|
|
- sonet-oc768
|
|
- sonet-oc1920
|
|
- sonet-oc3840
|
|
- 1gfc-sfp
|
|
- 2gfc-sfp
|
|
- 4gfc-sfp
|
|
- 8gfc-sfpp
|
|
- 16gfc-sfpp
|
|
- 32gfc-sfp28
|
|
- 64gfc-qsfpp
|
|
- 128gfc-sfp28
|
|
- infiniband-sdr
|
|
- infiniband-ddr
|
|
- infiniband-qdr
|
|
- infiniband-fdr10
|
|
- infiniband-fdr
|
|
- infiniband-edr
|
|
- infiniband-hdr
|
|
- infiniband-ndr
|
|
- infiniband-xdr
|
|
- t1
|
|
- e1
|
|
- t3
|
|
- e3
|
|
- cisco-stackwise
|
|
- cisco-stackwise-plus
|
|
- cisco-flexstack
|
|
- cisco-flexstack-plus
|
|
- juniper-vcp
|
|
- extreme-summitstack
|
|
- extreme-summitstack-128
|
|
- extreme-summitstack-256
|
|
- extreme-summitstack-512
|
|
- other
|
|
type: string
|
|
IntervalEnum:
|
|
enum:
|
|
- immediately
|
|
- future
|
|
- hourly
|
|
- daily
|
|
- weekly
|
|
type: string
|
|
InventoryItem:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
manufacturer:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedManufacturer'
|
|
nullable: true
|
|
part_id:
|
|
type: string
|
|
description: Manufacturer-assigned part identifier
|
|
maxLength: 50
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this item
|
|
maxLength: 50
|
|
discovered:
|
|
type: boolean
|
|
description: This item was automatically discovered
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
Job:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
source:
|
|
type: string
|
|
readOnly: true
|
|
description: Source of the Python code for this job - local, Git repository,
|
|
or plugins
|
|
module_name:
|
|
type: string
|
|
readOnly: true
|
|
description: Dotted name of the Python module providing this job
|
|
job_class_name:
|
|
type: string
|
|
readOnly: true
|
|
description: Name of the Python class providing this job
|
|
grouping:
|
|
type: string
|
|
description: Human-readable grouping that this job belongs to
|
|
maxLength: 255
|
|
grouping_override:
|
|
type: boolean
|
|
description: If set, the configured grouping will remain even if the underlying
|
|
Job source code changes
|
|
name:
|
|
type: string
|
|
description: Human-readable name of this job
|
|
maxLength: 100
|
|
name_override:
|
|
type: boolean
|
|
description: If set, the configured name will remain even if the underlying
|
|
Job source code changes
|
|
slug:
|
|
type: string
|
|
maxLength: 320
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
description: Markdown formatting is supported
|
|
description_override:
|
|
type: boolean
|
|
description: If set, the configured description will remain even if the
|
|
underlying Job source code changes
|
|
installed:
|
|
type: boolean
|
|
readOnly: true
|
|
description: Whether the Python module and class providing this job are
|
|
presently installed and loadable
|
|
enabled:
|
|
type: boolean
|
|
description: Whether this job can be executed by users
|
|
approval_required:
|
|
type: boolean
|
|
description: Whether the job requires approval from another user before
|
|
running
|
|
approval_required_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
commit_default:
|
|
type: boolean
|
|
description: Whether the job defaults to committing changes when run, or
|
|
defaults to a dry-run
|
|
commit_default_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
hidden:
|
|
type: boolean
|
|
description: Whether the job defaults to not being shown in the UI
|
|
hidden_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
read_only:
|
|
type: boolean
|
|
description: Whether the job is prevented from making lasting changes to
|
|
the database
|
|
read_only_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
soft_time_limit:
|
|
type: number
|
|
format: double
|
|
minimum: 0
|
|
description: Maximum runtime in seconds before the job will receive a <code>SoftTimeLimitExceeded</code>
|
|
exception.<br>Set to 0 to use Nautobot system default
|
|
soft_time_limit_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
time_limit:
|
|
type: number
|
|
format: double
|
|
minimum: 0
|
|
description: Maximum runtime in seconds before the job will be forcibly
|
|
terminated.<br>Set to 0 to use Nautobot system default
|
|
time_limit_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- grouping
|
|
- id
|
|
- installed
|
|
- job_class_name
|
|
- last_updated
|
|
- module_name
|
|
- name
|
|
- source
|
|
- url
|
|
JobClassDetail:
|
|
type: object
|
|
properties:
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
id:
|
|
type: string
|
|
readOnly: true
|
|
pk:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
readOnly: true
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
readOnly: true
|
|
maxLength: 255
|
|
test_methods:
|
|
type: array
|
|
items:
|
|
type: string
|
|
maxLength: 255
|
|
vars:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
result:
|
|
$ref: '#/components/schemas/JobResult'
|
|
required:
|
|
- description
|
|
- id
|
|
- name
|
|
- pk
|
|
- test_methods
|
|
- url
|
|
- vars
|
|
JobInput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
default: ''
|
|
commit:
|
|
type: boolean
|
|
schedule:
|
|
$ref: '#/components/schemas/NestedScheduledJob'
|
|
JobLogEntry:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
absolute_url:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
grouping:
|
|
type: string
|
|
maxLength: 100
|
|
job_result:
|
|
type: string
|
|
format: uuid
|
|
log_level:
|
|
$ref: '#/components/schemas/LogLevelEnum'
|
|
log_object:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 200
|
|
message:
|
|
type: string
|
|
required:
|
|
- id
|
|
- job_result
|
|
- url
|
|
JobResult:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
job_model:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedJob'
|
|
readOnly: true
|
|
obj_type:
|
|
type: string
|
|
readOnly: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- pending
|
|
- running
|
|
- completed
|
|
- errored
|
|
- failed
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Pending
|
|
- Running
|
|
- Completed
|
|
- Errored
|
|
- Failed
|
|
readOnly: true
|
|
user:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedUser'
|
|
readOnly: true
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
job_id:
|
|
type: string
|
|
format: uuid
|
|
schedule:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedScheduledJob'
|
|
readOnly: true
|
|
required:
|
|
- created
|
|
- id
|
|
- job_id
|
|
- job_model
|
|
- name
|
|
- obj_type
|
|
- schedule
|
|
- status
|
|
- url
|
|
- user
|
|
JobResultStatusEnum:
|
|
type: string
|
|
enum:
|
|
- pending
|
|
- running
|
|
- completed
|
|
- errored
|
|
- failed
|
|
JobRunResponse:
|
|
type: object
|
|
description: Serializer representing responses from the JobModelViewSet.run()
|
|
POST endpoint.
|
|
properties:
|
|
schedule:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedScheduledJob'
|
|
readOnly: true
|
|
job_result:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedJobResult'
|
|
readOnly: true
|
|
required:
|
|
- job_result
|
|
- schedule
|
|
JobVariable:
|
|
type: object
|
|
description: Serializer used for responses from the JobModelViewSet.variables()
|
|
detail endpoint.
|
|
properties:
|
|
name:
|
|
type: string
|
|
readOnly: true
|
|
type:
|
|
type: string
|
|
readOnly: true
|
|
label:
|
|
type: string
|
|
readOnly: true
|
|
help_text:
|
|
type: string
|
|
readOnly: true
|
|
default:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
required:
|
|
type: boolean
|
|
readOnly: true
|
|
min_length:
|
|
type: integer
|
|
readOnly: true
|
|
max_length:
|
|
type: integer
|
|
readOnly: true
|
|
min_value:
|
|
type: integer
|
|
readOnly: true
|
|
max_value:
|
|
type: integer
|
|
readOnly: true
|
|
choices:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
model:
|
|
type: string
|
|
readOnly: true
|
|
required:
|
|
- choices
|
|
- default
|
|
- help_text
|
|
- label
|
|
- max_length
|
|
- max_value
|
|
- min_length
|
|
- min_value
|
|
- model
|
|
- name
|
|
- required
|
|
- type
|
|
LengthUnitEnum:
|
|
enum:
|
|
- m
|
|
- cm
|
|
- ft
|
|
- in
|
|
type: string
|
|
LogLevelEnum:
|
|
enum:
|
|
- default
|
|
- success
|
|
- info
|
|
- warning
|
|
- failure
|
|
type: string
|
|
Manufacturer:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
devicetype_count:
|
|
type: integer
|
|
readOnly: true
|
|
inventoryitem_count:
|
|
type: integer
|
|
readOnly: true
|
|
platform_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- devicetype_count
|
|
- display
|
|
- id
|
|
- inventoryitem_count
|
|
- last_updated
|
|
- name
|
|
- platform_count
|
|
- url
|
|
MinMaxValidationRule:
|
|
type: object
|
|
description: Serializer for `MinMaxValidationRule` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
content_type:
|
|
type: string
|
|
field:
|
|
type: string
|
|
maxLength: 50
|
|
min:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
description: When set, apply a minimum value contraint to the value of the
|
|
model field.
|
|
max:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
description: When set, apply a maximum value contraint to the value of the
|
|
model field.
|
|
enabled:
|
|
type: boolean
|
|
error_message:
|
|
type: string
|
|
nullable: true
|
|
description: Optional error message to display when validation fails.
|
|
maxLength: 255
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- created
|
|
- display
|
|
- field
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- slug
|
|
- url
|
|
ModeEnum:
|
|
enum:
|
|
- access
|
|
- tagged
|
|
- tagged-all
|
|
type: string
|
|
NestedCVELCM:
|
|
type: object
|
|
description: Nested serializer for the CVE class.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
name:
|
|
type: string
|
|
maxLength: 16
|
|
published_date:
|
|
type: string
|
|
format: date
|
|
link:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
status:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
severity:
|
|
type: string
|
|
maxLength: 50
|
|
cvss:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSS Base Score
|
|
cvss_v2:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSSv2 Score
|
|
cvss_v3:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSSv3 Score
|
|
fix:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
comments:
|
|
type: string
|
|
required:
|
|
- display
|
|
- id
|
|
- link
|
|
- name
|
|
- published_date
|
|
- url
|
|
NestedCable:
|
|
type: object
|
|
description: |-
|
|
This base serializer implements common fields and logic for all ModelSerializers.
|
|
Namely it defines the `display` field which exposes a human friendly value for the given object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
label:
|
|
type: string
|
|
maxLength: 100
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- url
|
|
NestedCircuit:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
cid:
|
|
type: string
|
|
title: Circuit ID
|
|
maxLength: 100
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cid
|
|
- display
|
|
- id
|
|
- url
|
|
NestedCircuitType:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedCluster:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
NestedClusterGroup:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedClusterType:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedConfigContextSchema:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 200
|
|
slug:
|
|
type: string
|
|
maxLength: 200
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedContractLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
provider:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedProviderLCM'
|
|
description: Contract Provider
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
start:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract Start Date
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract End Date
|
|
cost:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
|
|
nullable: true
|
|
title: Contract Cost
|
|
support_level:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
contract_type:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 32
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- expired
|
|
- id
|
|
- name
|
|
- provider
|
|
NestedCustomField:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
title: Slug
|
|
description: URL-friendly unique shorthand.
|
|
maxLength: 50
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedDevice:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- url
|
|
NestedDeviceRole:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
NestedDeviceType:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
manufacturer:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedManufacturer'
|
|
readOnly: true
|
|
model:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- manufacturer
|
|
- model
|
|
- slug
|
|
- url
|
|
NestedIPAddress:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
type: integer
|
|
readOnly: true
|
|
address:
|
|
type: string
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- address
|
|
- display
|
|
- family
|
|
- id
|
|
- url
|
|
NestedInterface:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
cable:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedInventoryItem:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedJob:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
source:
|
|
type: string
|
|
readOnly: true
|
|
description: Source of the Python code for this job - local, Git repository,
|
|
or plugins
|
|
module_name:
|
|
type: string
|
|
readOnly: true
|
|
description: Dotted name of the Python module providing this job
|
|
job_class_name:
|
|
type: string
|
|
readOnly: true
|
|
description: Name of the Python class providing this job
|
|
grouping:
|
|
type: string
|
|
description: Human-readable grouping that this job belongs to
|
|
maxLength: 255
|
|
name:
|
|
type: string
|
|
description: Human-readable name of this job
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 320
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
required:
|
|
- grouping
|
|
- id
|
|
- job_class_name
|
|
- module_name
|
|
- name
|
|
- source
|
|
- url
|
|
NestedJobResult:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
user:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedUser'
|
|
readOnly: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- pending
|
|
- running
|
|
- completed
|
|
- errored
|
|
- failed
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Pending
|
|
- Running
|
|
- Completed
|
|
- Errored
|
|
- Failed
|
|
required:
|
|
- created
|
|
- id
|
|
- name
|
|
- status
|
|
- url
|
|
- user
|
|
NestedManufacturer:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
devicetype_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- devicetype_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedPlatform:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
NestedPowerPanel:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- powerfeed_count
|
|
- url
|
|
NestedPowerPort:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
cable:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedPowerPortTemplate:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedProvider:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedProviderLCM:
|
|
type: object
|
|
description: Nested serializer for the provider class.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
physical_address:
|
|
type: string
|
|
maxLength: 200
|
|
phone:
|
|
type: string
|
|
maxLength: 20
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
NestedProviderNetwork:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedRIR:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
aggregate_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- aggregate_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedRack:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_count
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedRackGroup:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- display
|
|
- id
|
|
- name
|
|
- rack_count
|
|
- url
|
|
NestedRackRole:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- rack_count
|
|
- url
|
|
NestedRearPortTemplate:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedRegion:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- display
|
|
- id
|
|
- name
|
|
- site_count
|
|
- url
|
|
NestedRelationship:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Internal relationship name
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedRole:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- prefix_count
|
|
- url
|
|
- vlan_count
|
|
NestedScheduledJob:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
start_time:
|
|
type: string
|
|
format: date-time
|
|
interval:
|
|
$ref: '#/components/schemas/IntervalEnum'
|
|
required:
|
|
- interval
|
|
NestedSecret:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedSecretsGroup:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedSecretsGroupAssociation:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
access_type:
|
|
$ref: '#/components/schemas/AccessTypeEnum'
|
|
secret_type:
|
|
$ref: '#/components/schemas/SecretTypeEnum'
|
|
secret:
|
|
$ref: '#/components/schemas/NestedSecret'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- access_type
|
|
- display
|
|
- id
|
|
- secret
|
|
- secret_type
|
|
- url
|
|
NestedSite:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedSoftwareLCM:
|
|
type: object
|
|
description: Nested/brief serializer for SoftwareLCM.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_platform:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
version:
|
|
type: string
|
|
maxLength: 50
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Support
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_platform
|
|
- display
|
|
- id
|
|
- url
|
|
- version
|
|
NestedTenant:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
NestedTenantGroup:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
tenant_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- display
|
|
- id
|
|
- name
|
|
- tenant_count
|
|
- url
|
|
NestedUser:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
username:
|
|
type: string
|
|
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
|
|
only.
|
|
pattern: ^[\w.@+-]+$
|
|
maxLength: 150
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- url
|
|
- username
|
|
NestedVLAN:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
vid:
|
|
type: integer
|
|
maximum: 4094
|
|
minimum: 1
|
|
title: ID
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- vid
|
|
NestedVLANGroup:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- vlan_count
|
|
NestedVRF:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
rd:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Unique route distinguisher (as defined in RFC 4364)
|
|
maxLength: 21
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- prefix_count
|
|
- url
|
|
NestedVirtualChassis:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
master:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
member_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- master
|
|
- member_count
|
|
- name
|
|
- url
|
|
NestedVirtualMachine:
|
|
type: object
|
|
description: |-
|
|
Returns a nested representation of an object on read, but accepts either the nested representation or the
|
|
primary key value on write operations.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
Note:
|
|
type: object
|
|
description: Serializer for API.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
maintenance:
|
|
type: string
|
|
format: uuid
|
|
title:
|
|
type: string
|
|
maxLength: 200
|
|
comment:
|
|
type: string
|
|
required:
|
|
- comment
|
|
- id
|
|
- title
|
|
NotificationSource:
|
|
type: object
|
|
description: Serializer for NotificationSource records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Notification Source Name as defined in configuration file.
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
providers:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedProvider'
|
|
attach_all_providers:
|
|
type: boolean
|
|
description: Attach all the Providers to this Notification Source
|
|
required:
|
|
- id
|
|
- name
|
|
- providers
|
|
- slug
|
|
- url
|
|
NullEnum:
|
|
enum:
|
|
- null
|
|
ObjectChange:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
user:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedUser'
|
|
readOnly: true
|
|
user_name:
|
|
type: string
|
|
readOnly: true
|
|
request_id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
action:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- create
|
|
- update
|
|
- delete
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Created
|
|
- Updated
|
|
- Deleted
|
|
readOnly: true
|
|
changed_object_type:
|
|
type: string
|
|
readOnly: true
|
|
changed_object_id:
|
|
type: string
|
|
format: uuid
|
|
changed_object:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
object_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
required:
|
|
- action
|
|
- changed_object
|
|
- changed_object_id
|
|
- changed_object_type
|
|
- id
|
|
- object_data
|
|
- request_id
|
|
- time
|
|
- url
|
|
- user
|
|
- user_name
|
|
ObjectPermission:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
enabled:
|
|
type: boolean
|
|
object_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
groups:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 150
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
users:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
username:
|
|
type: string
|
|
description: Required. 150 characters or fewer. Letters, digits and
|
|
@/./+/-/_ only.
|
|
pattern: ^[\w.@+-]+$
|
|
maxLength: 150
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- url
|
|
- username
|
|
actions:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: The list of actions granted by this permission
|
|
constraints:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable objects of the selected
|
|
type(s)
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- actions
|
|
- display
|
|
- id
|
|
- name
|
|
- object_types
|
|
- url
|
|
OnboardingTask:
|
|
type: object
|
|
description: Serializer for the OnboardingTask model.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
site:
|
|
type: string
|
|
description: Nautobot site 'slug' value
|
|
ip_address:
|
|
type: string
|
|
description: IP Address to reach device
|
|
username:
|
|
type: string
|
|
writeOnly: true
|
|
description: Device username
|
|
password:
|
|
type: string
|
|
writeOnly: true
|
|
description: Device password
|
|
secret:
|
|
type: string
|
|
writeOnly: true
|
|
description: Device secret password
|
|
port:
|
|
type: integer
|
|
description: Device PORT to check for online
|
|
timeout:
|
|
type: integer
|
|
description: Timeout (sec) for device connect
|
|
role:
|
|
type: string
|
|
description: Nautobot device role 'slug' value
|
|
device_type:
|
|
type: string
|
|
description: Nautobot device type 'slug' value
|
|
platform:
|
|
type: string
|
|
description: Nautobot Platform 'slug' value
|
|
created_device:
|
|
type: string
|
|
readOnly: true
|
|
description: Created device name
|
|
status:
|
|
type: string
|
|
readOnly: true
|
|
description: Onboarding Status
|
|
failed_reason:
|
|
type: string
|
|
readOnly: true
|
|
description: Failure reason
|
|
message:
|
|
type: string
|
|
readOnly: true
|
|
description: Status message
|
|
required:
|
|
- created_device
|
|
- failed_reason
|
|
- id
|
|
- ip_address
|
|
- message
|
|
- site
|
|
- status
|
|
OuterUnitEnum:
|
|
enum:
|
|
- mm
|
|
- in
|
|
type: string
|
|
PaginatedAccessGrantList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessGrant'
|
|
PaginatedAggregateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Aggregate'
|
|
PaginatedAvailableIPList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AvailableIP'
|
|
PaginatedAvailablePrefixList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AvailablePrefix'
|
|
PaginatedCVELCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CVELCM'
|
|
PaginatedCableList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Cable'
|
|
PaginatedCircuitList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Circuit'
|
|
PaginatedCircuitMaintenanceCircuitImpactList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
|
|
PaginatedCircuitMaintenanceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CircuitMaintenance'
|
|
PaginatedCircuitTerminationList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CircuitTermination'
|
|
PaginatedCircuitTypeList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CircuitType'
|
|
PaginatedClusterGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ClusterGroup'
|
|
PaginatedClusterList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Cluster'
|
|
PaginatedClusterTypeList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ClusterType'
|
|
PaginatedCommandTokenList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CommandToken'
|
|
PaginatedComplianceFeatureList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ComplianceFeature'
|
|
PaginatedComplianceRuleList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ComplianceRule'
|
|
PaginatedComputedFieldList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ComputedField'
|
|
PaginatedConfigComplianceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConfigCompliance'
|
|
PaginatedConfigContextList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConfigContext'
|
|
PaginatedConfigContextSchemaList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConfigContextSchema'
|
|
PaginatedConfigRemoveList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConfigRemove'
|
|
PaginatedConfigReplaceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConfigReplace'
|
|
PaginatedConsolePortList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConsolePort'
|
|
PaginatedConsolePortTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConsolePortTemplate'
|
|
PaginatedConsoleServerPortList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConsoleServerPort'
|
|
PaginatedConsoleServerPortTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConsoleServerPortTemplate'
|
|
PaginatedContactLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ContactLCM'
|
|
PaginatedContentTypeList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ContentType'
|
|
PaginatedContractLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ContractLCM'
|
|
PaginatedCustomFieldChoiceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CustomFieldChoice'
|
|
PaginatedCustomFieldList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CustomField'
|
|
PaginatedCustomLinkList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CustomLink'
|
|
PaginatedDeviceBayList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/DeviceBay'
|
|
PaginatedDeviceBayTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/DeviceBayTemplate'
|
|
PaginatedDeviceRoleList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/DeviceRole'
|
|
PaginatedDeviceTypeList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/DeviceType'
|
|
PaginatedDeviceWithConfigContextList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/DeviceWithConfigContext'
|
|
PaginatedDynamicGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/DynamicGroup'
|
|
PaginatedExportTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ExportTemplate'
|
|
PaginatedFrontPortList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FrontPort'
|
|
PaginatedFrontPortTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FrontPortTemplate'
|
|
PaginatedGitRepositoryList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/GitRepository'
|
|
PaginatedGoldenConfigList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/GoldenConfig'
|
|
PaginatedGoldenConfigSettingList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/GoldenConfigSetting'
|
|
PaginatedGraphQLQueryList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/GraphQLQuery'
|
|
PaginatedGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Group'
|
|
PaginatedHardwareLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/HardwareLCM'
|
|
PaginatedIPAddressList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/IPAddress'
|
|
PaginatedImageAttachmentList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ImageAttachment'
|
|
PaginatedInterfaceConnectionList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/InterfaceConnection'
|
|
PaginatedInterfaceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Interface'
|
|
PaginatedInterfaceTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/InterfaceTemplate'
|
|
PaginatedInventoryItemList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/InventoryItem'
|
|
PaginatedJobList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Job'
|
|
PaginatedJobLogEntryList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/JobLogEntry'
|
|
PaginatedJobResultList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/JobResult'
|
|
PaginatedJobVariableList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/JobVariable'
|
|
PaginatedManufacturerList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Manufacturer'
|
|
PaginatedMinMaxValidationRuleList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/MinMaxValidationRule'
|
|
PaginatedNoteList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Note'
|
|
PaginatedNotificationSourceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NotificationSource'
|
|
PaginatedObjectChangeList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ObjectChange'
|
|
PaginatedObjectPermissionList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ObjectPermission'
|
|
PaginatedOnboardingTaskList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/OnboardingTask'
|
|
PaginatedPlatformList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Platform'
|
|
PaginatedPowerFeedList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/PowerFeed'
|
|
PaginatedPowerOutletList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/PowerOutlet'
|
|
PaginatedPowerOutletTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/PowerOutletTemplate'
|
|
PaginatedPowerPanelList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/PowerPanel'
|
|
PaginatedPowerPortList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/PowerPort'
|
|
PaginatedPowerPortTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/PowerPortTemplate'
|
|
PaginatedPrefixList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Prefix'
|
|
PaginatedProviderLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ProviderLCM'
|
|
PaginatedProviderList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Provider'
|
|
PaginatedProviderNetworkList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ProviderNetwork'
|
|
PaginatedRIRList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RIR'
|
|
PaginatedRackGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RackGroup'
|
|
PaginatedRackList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Rack'
|
|
PaginatedRackReservationList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RackReservation'
|
|
PaginatedRackRoleList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RackRole'
|
|
PaginatedRackUnitList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RackUnit'
|
|
PaginatedRearPortList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RearPort'
|
|
PaginatedRearPortTemplateList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RearPortTemplate'
|
|
PaginatedRegionList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Region'
|
|
PaginatedRegularExpressionValidationRuleList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RegularExpressionValidationRule'
|
|
PaginatedRelationshipAssociationList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RelationshipAssociation'
|
|
PaginatedRelationshipList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Relationship'
|
|
PaginatedRoleList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Role'
|
|
PaginatedRouteTargetList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RouteTarget'
|
|
PaginatedScheduledJobList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ScheduledJob'
|
|
PaginatedSecretList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Secret'
|
|
PaginatedSecretsGroupAssociationList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SecretsGroupAssociation'
|
|
PaginatedSecretsGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SecretsGroup'
|
|
PaginatedServiceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Service'
|
|
PaginatedSiteList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Site'
|
|
PaginatedSoftwareImageLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SoftwareImageLCM'
|
|
PaginatedSoftwareLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SoftwareLCM'
|
|
PaginatedStatusList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Status'
|
|
PaginatedTagSerializerVersion13List:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerVersion13'
|
|
PaginatedTenantGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TenantGroup'
|
|
PaginatedTenantList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Tenant'
|
|
PaginatedTokenList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Token'
|
|
PaginatedUserList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/User'
|
|
PaginatedVLANGroupList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VLANGroup'
|
|
PaginatedVLANList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VLAN'
|
|
PaginatedVMInterfaceList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VMInterface'
|
|
PaginatedVRFList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VRF'
|
|
PaginatedValidatedSoftwareLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ValidatedSoftwareLCM'
|
|
PaginatedVirtualChassisList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VirtualChassis'
|
|
PaginatedVirtualMachineWithConfigContextList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VirtualMachineWithConfigContext'
|
|
PaginatedVulnerabilityLCMList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/VulnerabilityLCM'
|
|
PaginatedWebhookList:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
example: 123
|
|
next:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=400&limit=100
|
|
previous:
|
|
type: string
|
|
nullable: true
|
|
format: uri
|
|
example: http://api.example.org/accounts/?offset=200&limit=100
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Webhook'
|
|
PatchedAccessGrant:
|
|
type: object
|
|
description: API serializer for interacting with AccessGrant objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
command:
|
|
type: string
|
|
description: Enter <tt>*</tt> to grant access to all commands
|
|
maxLength: 64
|
|
subcommand:
|
|
type: string
|
|
description: Enter <tt>*</tt> to grant access to all subcommands of the
|
|
given command
|
|
maxLength: 64
|
|
grant_type:
|
|
$ref: '#/components/schemas/GrantTypeEnum'
|
|
name:
|
|
type: string
|
|
description: Organization name, channel name, or user name
|
|
maxLength: 255
|
|
value:
|
|
type: string
|
|
description: Corresponding ID value to grant access to.<br>Enter <tt>*</tt>
|
|
to grant access to all organizations, channels, or users
|
|
maxLength: 255
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedCVELCM:
|
|
type: object
|
|
description: REST API serializer for CVELCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 16
|
|
published_date:
|
|
type: string
|
|
format: date
|
|
link:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
status:
|
|
$ref: '#/components/schemas/Status4f5Enum'
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
severity:
|
|
type: string
|
|
maxLength: 50
|
|
cvss:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSS Base Score
|
|
cvss_v2:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSSv2 Score
|
|
cvss_v3:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
title: CVSSv3 Score
|
|
fix:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 255
|
|
comments:
|
|
type: string
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedCircuitMaintenance:
|
|
type: object
|
|
description: Serializer for API.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
start_time:
|
|
type: string
|
|
format: date-time
|
|
end_time:
|
|
type: string
|
|
format: date-time
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
status:
|
|
nullable: true
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CircuitMaintenanceStatusEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
- $ref: '#/components/schemas/NullEnum'
|
|
ack:
|
|
type: boolean
|
|
nullable: true
|
|
PatchedCircuitMaintenanceCircuitImpact:
|
|
type: object
|
|
description: Serializer for API.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
maintenance:
|
|
type: string
|
|
format: uuid
|
|
circuit:
|
|
type: string
|
|
format: uuid
|
|
impact:
|
|
nullable: true
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImpactEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
- $ref: '#/components/schemas/NullEnum'
|
|
PatchedCircuitType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedClusterGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedClusterType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedCommandToken:
|
|
type: object
|
|
description: API serializer for interacting with CommandToken objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
comment:
|
|
type: string
|
|
description: 'Optional: Enter description of token'
|
|
maxLength: 255
|
|
platform:
|
|
$ref: '#/components/schemas/PlatformEnum'
|
|
token:
|
|
type: string
|
|
description: Token given by chat platform for signing or command validation
|
|
maxLength: 255
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedComplianceFeature:
|
|
type: object
|
|
description: Serializer for ComplianceFeature object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
PatchedComplianceRule:
|
|
type: object
|
|
description: Serializer for ComplianceRule object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
config_ordered:
|
|
type: boolean
|
|
title: Configured Ordered
|
|
description: Whether or not the configuration order matters, such as in
|
|
ACLs.
|
|
match_config:
|
|
type: string
|
|
nullable: true
|
|
title: Config to Match
|
|
description: The config to match that is matched based on the parent most
|
|
configuration. e.g. `router bgp` or `ntp`.
|
|
config_type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ConfigTypeEnum'
|
|
description: Whether the config is in cli or json/structured format.
|
|
feature:
|
|
type: string
|
|
format: uuid
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
PatchedComputedField:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
slug:
|
|
type: string
|
|
description: Internal field name
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
label:
|
|
type: string
|
|
description: Name of the field as displayed to users
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
content_type:
|
|
type: string
|
|
template:
|
|
type: string
|
|
description: Jinja2 template code for field value
|
|
maxLength: 500
|
|
fallback_value:
|
|
type: string
|
|
description: Fallback value (if any) to be output for the field in the case
|
|
of a template rendering error.
|
|
maxLength: 500
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedConfigCompliance:
|
|
type: object
|
|
description: Serializer for ConfigCompliance object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
compliance:
|
|
type: boolean
|
|
nullable: true
|
|
actual:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Actual Configuration for feature
|
|
intended:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Intended Configuration for feature
|
|
missing:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Configuration that should be on the device.
|
|
extra:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: Configuration that should not be on the device.
|
|
ordered:
|
|
type: boolean
|
|
compliance_int:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: -2147483648
|
|
nullable: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
description: The device
|
|
rule:
|
|
type: string
|
|
format: uuid
|
|
PatchedConfigContextSchema:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 200
|
|
slug:
|
|
type: string
|
|
maxLength: 200
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
data_schema:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: A JSON Schema document which is used to validate a config context
|
|
object.
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedConfigRemove:
|
|
type: object
|
|
description: Serializer for ConfigRemove object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
regex:
|
|
type: string
|
|
title: Regex Pattern
|
|
description: Regex pattern used to remove a line from the backup configuration.
|
|
maxLength: 200
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
PatchedConfigReplace:
|
|
type: object
|
|
description: Serializer for ConfigReplace object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
regex:
|
|
type: string
|
|
title: Regex Pattern to Substitute
|
|
description: Regex pattern that will be found and replaced with 'replaced
|
|
text'.
|
|
maxLength: 200
|
|
replace:
|
|
type: string
|
|
title: Replaced Text
|
|
description: Text that will be inserted in place of Regex pattern match.
|
|
maxLength: 200
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
PatchedCustomLink:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
target_url:
|
|
type: string
|
|
title: URL
|
|
description: Jinja2 template code for link URL. Reference the object as
|
|
<code>{{ obj }}</code> such as <code>{{ obj.platform.slug }}</code>.
|
|
maxLength: 500
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
content_type:
|
|
type: string
|
|
text:
|
|
type: string
|
|
description: Jinja2 template code for link text. Reference the object as
|
|
<code>{{ obj }}</code> such as <code>{{ obj.platform.slug }}</code>. Links
|
|
which render as empty text will not be displayed.
|
|
maxLength: 500
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
group_name:
|
|
type: string
|
|
description: Links with the same group will appear as a dropdown menu
|
|
maxLength: 50
|
|
button_class:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ButtonClassEnum'
|
|
description: The class of the first link in a group will be used for the
|
|
dropdown button
|
|
new_window:
|
|
type: boolean
|
|
description: Force link to open in a new window
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedDeviceRole:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
vm_role:
|
|
type: boolean
|
|
description: Virtual machines may be assigned to this role
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedDynamicGroup:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Dynamic Group name
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
description: Unique slug
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
content_type:
|
|
type: string
|
|
filter:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: A JSON-encoded dictionary of filter parameters for group membership
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedExportTemplate:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_type:
|
|
type: string
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
template_code:
|
|
type: string
|
|
description: The list of objects being exported is passed as a context variable
|
|
named <code>queryset</code>.
|
|
mime_type:
|
|
type: string
|
|
description: Defaults to <code>text/plain</code>
|
|
maxLength: 50
|
|
file_extension:
|
|
type: string
|
|
description: Extension to append to the rendered filename
|
|
maxLength: 15
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedGoldenConfig:
|
|
type: object
|
|
description: Serializer for GoldenConfig object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
backup_config:
|
|
type: string
|
|
description: Full backup config for device.
|
|
backup_last_attempt_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
backup_last_success_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
intended_config:
|
|
type: string
|
|
description: Intended config for the device.
|
|
intended_last_attempt_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
intended_last_success_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
compliance_config:
|
|
type: string
|
|
description: Full config diff for device.
|
|
compliance_last_attempt_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
compliance_last_success_date:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
description: device
|
|
PatchedGoldenConfigSetting:
|
|
type: object
|
|
description: Serializer for GoldenConfigSetting object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
_custom_field_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
title: ' custom field data'
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
backup_path_template:
|
|
type: string
|
|
title: Backup Path in Jinja Template Form
|
|
description: The Jinja path representation of where the backup file will
|
|
be found. The variable `obj` is available as the device instance object
|
|
of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg`
|
|
maxLength: 255
|
|
intended_path_template:
|
|
type: string
|
|
title: Intended Path in Jinja Template Form
|
|
description: The Jinja path representation of where the generated file will
|
|
be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg`
|
|
maxLength: 255
|
|
jinja_path_template:
|
|
type: string
|
|
title: Template Path in Jinja Template Form
|
|
description: The Jinja path representation of where the Jinja template can
|
|
be found. e.g. `{{obj.platform.slug}}.j2`
|
|
maxLength: 255
|
|
backup_test_connectivity:
|
|
type: boolean
|
|
title: Backup Test
|
|
description: Whether or not to pretest the connectivity of the device by
|
|
verifying there is a resolvable IP that can connect to port 22.
|
|
scope:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: API filter in JSON format matching the list of devices for
|
|
the scope of devices to be considered.
|
|
backup_repository:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
intended_repository:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
jinja_repository:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
sot_agg_query:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
PatchedGraphQLQuery:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
query:
|
|
type: string
|
|
variables:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
default: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedGroup:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: integer
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 150
|
|
user_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedImageAttachment:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_type:
|
|
type: string
|
|
object_id:
|
|
type: string
|
|
format: uuid
|
|
parent:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 50
|
|
image:
|
|
type: string
|
|
format: uri
|
|
image_height:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
image_width:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedJob:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
source:
|
|
type: string
|
|
readOnly: true
|
|
description: Source of the Python code for this job - local, Git repository,
|
|
or plugins
|
|
module_name:
|
|
type: string
|
|
readOnly: true
|
|
description: Dotted name of the Python module providing this job
|
|
job_class_name:
|
|
type: string
|
|
readOnly: true
|
|
description: Name of the Python class providing this job
|
|
grouping:
|
|
type: string
|
|
description: Human-readable grouping that this job belongs to
|
|
maxLength: 255
|
|
grouping_override:
|
|
type: boolean
|
|
description: If set, the configured grouping will remain even if the underlying
|
|
Job source code changes
|
|
name:
|
|
type: string
|
|
description: Human-readable name of this job
|
|
maxLength: 100
|
|
name_override:
|
|
type: boolean
|
|
description: If set, the configured name will remain even if the underlying
|
|
Job source code changes
|
|
slug:
|
|
type: string
|
|
maxLength: 320
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
description: Markdown formatting is supported
|
|
description_override:
|
|
type: boolean
|
|
description: If set, the configured description will remain even if the
|
|
underlying Job source code changes
|
|
installed:
|
|
type: boolean
|
|
readOnly: true
|
|
description: Whether the Python module and class providing this job are
|
|
presently installed and loadable
|
|
enabled:
|
|
type: boolean
|
|
description: Whether this job can be executed by users
|
|
approval_required:
|
|
type: boolean
|
|
description: Whether the job requires approval from another user before
|
|
running
|
|
approval_required_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
commit_default:
|
|
type: boolean
|
|
description: Whether the job defaults to committing changes when run, or
|
|
defaults to a dry-run
|
|
commit_default_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
hidden:
|
|
type: boolean
|
|
description: Whether the job defaults to not being shown in the UI
|
|
hidden_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
read_only:
|
|
type: boolean
|
|
description: Whether the job is prevented from making lasting changes to
|
|
the database
|
|
read_only_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
soft_time_limit:
|
|
type: number
|
|
format: double
|
|
minimum: 0
|
|
description: Maximum runtime in seconds before the job will receive a <code>SoftTimeLimitExceeded</code>
|
|
exception.<br>Set to 0 to use Nautobot system default
|
|
soft_time_limit_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
time_limit:
|
|
type: number
|
|
format: double
|
|
minimum: 0
|
|
description: Maximum runtime in seconds before the job will be forcibly
|
|
terminated.<br>Set to 0 to use Nautobot system default
|
|
time_limit_override:
|
|
type: boolean
|
|
description: If set, the configured value will remain even if the underlying
|
|
Job source code changes
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedJobResult:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 255
|
|
job_model:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedJob'
|
|
readOnly: true
|
|
obj_type:
|
|
type: string
|
|
readOnly: true
|
|
status:
|
|
allOf:
|
|
- $ref: '#/components/schemas/JobResultStatusEnum'
|
|
readOnly: true
|
|
user:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedUser'
|
|
readOnly: true
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
job_id:
|
|
type: string
|
|
format: uuid
|
|
schedule:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedScheduledJob'
|
|
readOnly: true
|
|
PatchedManufacturer:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
devicetype_count:
|
|
type: integer
|
|
readOnly: true
|
|
inventoryitem_count:
|
|
type: integer
|
|
readOnly: true
|
|
platform_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedMinMaxValidationRule:
|
|
type: object
|
|
description: Serializer for `MinMaxValidationRule` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
content_type:
|
|
type: string
|
|
field:
|
|
type: string
|
|
maxLength: 50
|
|
min:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
description: When set, apply a minimum value contraint to the value of the
|
|
model field.
|
|
max:
|
|
type: number
|
|
format: double
|
|
nullable: true
|
|
description: When set, apply a maximum value contraint to the value of the
|
|
model field.
|
|
enabled:
|
|
type: boolean
|
|
error_message:
|
|
type: string
|
|
nullable: true
|
|
description: Optional error message to display when validation fails.
|
|
maxLength: 255
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedNote:
|
|
type: object
|
|
description: Serializer for API.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
maintenance:
|
|
type: string
|
|
format: uuid
|
|
title:
|
|
type: string
|
|
maxLength: 200
|
|
comment:
|
|
type: string
|
|
PatchedProvider:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
asn:
|
|
type: integer
|
|
maximum: 4294967295
|
|
minimum: 1
|
|
format: int64
|
|
nullable: true
|
|
description: 32-bit autonomous system number
|
|
account:
|
|
type: string
|
|
title: Account number
|
|
maxLength: 100
|
|
portal_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
noc_contact:
|
|
type: string
|
|
admin_contact:
|
|
type: string
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedProviderLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
physical_address:
|
|
type: string
|
|
maxLength: 200
|
|
phone:
|
|
type: string
|
|
maxLength: 20
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedRIR:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
is_private:
|
|
type: boolean
|
|
title: Private
|
|
description: IP space managed by this RIR is considered private
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
aggregate_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedRackRole:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedRegularExpressionValidationRule:
|
|
type: object
|
|
description: Serializer for `RegularExpressionValidationRule` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
content_type:
|
|
type: string
|
|
field:
|
|
type: string
|
|
maxLength: 50
|
|
regular_expression:
|
|
type: string
|
|
enabled:
|
|
type: boolean
|
|
error_message:
|
|
type: string
|
|
nullable: true
|
|
description: Optional error message to display when validation fails.
|
|
maxLength: 255
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedRelationship:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Internal relationship name
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/RelationshipTypeChoices'
|
|
description: Cardinality of this relationship
|
|
source_type:
|
|
type: string
|
|
source_label:
|
|
type: string
|
|
description: Label for related destination objects, as displayed on the
|
|
source object.
|
|
maxLength: 50
|
|
source_hidden:
|
|
type: boolean
|
|
title: Hide for source object
|
|
description: Hide this relationship on the source object.
|
|
source_filter:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable source objects of the
|
|
selected type
|
|
destination_type:
|
|
type: string
|
|
destination_label:
|
|
type: string
|
|
description: Label for related source objects, as displayed on the destination
|
|
object.
|
|
maxLength: 50
|
|
destination_hidden:
|
|
type: boolean
|
|
title: Hide for destination object
|
|
description: Hide this relationship on the destination object.
|
|
destination_filter:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable destination objects
|
|
of the selected type
|
|
PatchedRole:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedSecret:
|
|
type: object
|
|
description: Serializer for `Secret` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
provider:
|
|
type: string
|
|
maxLength: 100
|
|
parameters:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedSecretsGroup:
|
|
type: object
|
|
description: Serializer for `SecretsGroup` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
secrets:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedSecretsGroupAssociation'
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedStatus:
|
|
type: object
|
|
description: Serializer for `Status` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
name:
|
|
type: string
|
|
maxLength: 50
|
|
slug:
|
|
type: string
|
|
maxLength: 50
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedTagSerializerVersion13:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tagged_items:
|
|
type: integer
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedToken:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
expires:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
key:
|
|
type: string
|
|
maxLength: 40
|
|
minLength: 40
|
|
write_enabled:
|
|
type: boolean
|
|
description: Permit create/update/delete operations using this key
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
PatchedVulnerabilityLCM:
|
|
type: object
|
|
description: REST API serializer for VulnerabilityLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
cve:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCVELCM'
|
|
readOnly: true
|
|
software:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSoftwareLCM'
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
inventory_item:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedInventoryItem'
|
|
readOnly: true
|
|
status:
|
|
$ref: '#/components/schemas/Status4f5Enum'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
PatchedWebhook:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
name:
|
|
type: string
|
|
maxLength: 150
|
|
type_create:
|
|
type: boolean
|
|
description: Call this webhook when a matching object is created.
|
|
type_update:
|
|
type: boolean
|
|
description: Call this webhook when a matching object is updated.
|
|
type_delete:
|
|
type: boolean
|
|
description: Call this webhook when a matching object is deleted.
|
|
payload_url:
|
|
type: string
|
|
title: URL
|
|
description: A POST will be sent to this URL when the webhook is called.
|
|
maxLength: 500
|
|
http_method:
|
|
$ref: '#/components/schemas/HttpMethodEnum'
|
|
http_content_type:
|
|
type: string
|
|
description: The complete list of official content types is available <a
|
|
href="https://www.iana.org/assignments/media-types/media-types.xhtml">here</a>.
|
|
maxLength: 100
|
|
additional_headers:
|
|
type: string
|
|
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 support with the
|
|
same context as the request body (below).'
|
|
body_template:
|
|
type: string
|
|
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>.'
|
|
secret:
|
|
type: string
|
|
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.
|
|
maxLength: 255
|
|
ssl_verification:
|
|
type: boolean
|
|
description: Enable SSL certificate verification. Disable with caution!
|
|
ca_file_path:
|
|
type: string
|
|
nullable: true
|
|
description: The specific CA certificate file to use for SSL verification.
|
|
Leave blank to use the system defaults.
|
|
maxLength: 4096
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableAggregate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FamilyEnum'
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
rir:
|
|
type: string
|
|
format: uuid
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
date_added:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableCable:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
termination_a_type:
|
|
type: string
|
|
termination_a_id:
|
|
type: string
|
|
format: uuid
|
|
termination_a:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
termination_b_type:
|
|
type: string
|
|
termination_b_id:
|
|
type: string
|
|
format: uuid
|
|
termination_b:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CableTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
status:
|
|
$ref: '#/components/schemas/WritableCableStatusEnum'
|
|
label:
|
|
type: string
|
|
maxLength: 100
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
length:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
length_unit:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LengthUnitEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableCircuit:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
cid:
|
|
type: string
|
|
title: Circuit ID
|
|
maxLength: 100
|
|
provider:
|
|
type: string
|
|
format: uuid
|
|
type:
|
|
type: string
|
|
format: uuid
|
|
status:
|
|
$ref: '#/components/schemas/WritableCircuitStatusEnum'
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
install_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Date installed
|
|
commit_rate:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Commit rate (Kbps)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
termination_a:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CircuitCircuitTermination'
|
|
readOnly: true
|
|
termination_z:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CircuitCircuitTermination'
|
|
readOnly: true
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableCircuitTermination:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
circuit:
|
|
type: string
|
|
format: uuid
|
|
term_side:
|
|
allOf:
|
|
- $ref: '#/components/schemas/TermSideEnum'
|
|
title: Termination
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
provider_network:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
port_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Port speed (Kbps)
|
|
upstream_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Upstream speed (Kbps)
|
|
description: Upstream speed, if different from port speed
|
|
xconnect_id:
|
|
type: string
|
|
title: Cross-connect ID
|
|
maxLength: 50
|
|
pp_info:
|
|
type: string
|
|
title: Patch panel/port(s)
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableCluster:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
type:
|
|
type: string
|
|
format: uuid
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableConfigContext:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optional schema to validate the structure of the data
|
|
is_active:
|
|
type: boolean
|
|
regions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
sites:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
roles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
platforms:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
cluster_groups:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
clusters:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tenant_groups:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tenants:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableConsolePort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableConsolePortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableConsoleServerPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableConsoleServerPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableContactLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 80
|
|
address:
|
|
type: string
|
|
maxLength: 200
|
|
phone:
|
|
type: string
|
|
maxLength: 20
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: Contact E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
priority:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
contract:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableContractLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
provider:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Vendor
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
start:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract Start Date
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract End Date
|
|
cost:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
|
|
nullable: true
|
|
title: Contract Cost
|
|
support_level:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
contract_type:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 32
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableCustomField:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CustomFieldTypeChoices'
|
|
description: The type of value(s) allowed for this field.
|
|
name:
|
|
type: string
|
|
title: Slug
|
|
description: URL-friendly unique shorthand.
|
|
maxLength: 50
|
|
label:
|
|
type: string
|
|
description: Name of the field as displayed to users (if not provided, the
|
|
field's slug will be used.)
|
|
maxLength: 50
|
|
description:
|
|
type: string
|
|
description: A helpful description for this field.
|
|
maxLength: 200
|
|
required:
|
|
type: boolean
|
|
description: If true, this field is required when creating new objects or
|
|
editing an existing object.
|
|
filter_logic:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FilterLogicEnum'
|
|
description: Loose matches any instance of a given string; Exact matches
|
|
the entire field.
|
|
default:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Default value for the field (must be a JSON value). Encapsulate
|
|
strings with double quotes (e.g. "Foo").
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description: Fields with higher weights appear lower in a form.
|
|
validation_minimum:
|
|
type: integer
|
|
maximum: 9223372036854775807
|
|
minimum: -9223372036854775808
|
|
format: int64
|
|
nullable: true
|
|
title: Minimum value
|
|
description: Minimum allowed value (for numeric fields).
|
|
validation_maximum:
|
|
type: integer
|
|
maximum: 9223372036854775807
|
|
minimum: -9223372036854775808
|
|
format: int64
|
|
nullable: true
|
|
title: Maximum value
|
|
description: Maximum allowed value (for numeric fields).
|
|
validation_regex:
|
|
type: string
|
|
description: Regular expression to enforce on text field values. Use ^ and
|
|
$ to force matching of entire string. For example, <code>^[A-Z]{3}$</code>
|
|
will limit values to exactly three uppercase letters. Regular expression
|
|
on select and multi-select will be applied at <code>Custom Field Choices</code>
|
|
definition.
|
|
maxLength: 500
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableCustomFieldChoice:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
field:
|
|
type: string
|
|
format: uuid
|
|
value:
|
|
type: string
|
|
maxLength: 100
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description: Higher weights appear later in the list
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableDeviceBay:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
installed_device:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableDeviceBayTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableDeviceType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
manufacturer:
|
|
type: string
|
|
format: uuid
|
|
model:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
part_number:
|
|
type: string
|
|
description: Discrete part number (optional)
|
|
maxLength: 50
|
|
u_height:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
title: Height (U)
|
|
is_full_depth:
|
|
type: boolean
|
|
description: Device consumes both front and rear rack faces
|
|
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.
|
|
oneOf:
|
|
- $ref: '#/components/schemas/SubdeviceRoleEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
front_image:
|
|
type: string
|
|
format: uri
|
|
rear_image:
|
|
type: string
|
|
format: uri
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableDeviceWithConfigContext:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
device_role:
|
|
type: string
|
|
format: uuid
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this device
|
|
maxLength: 50
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
rack:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
position:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
title: Position (U)
|
|
description: The lowest-numbered unit occupied by the device
|
|
face:
|
|
title: Rack face
|
|
oneOf:
|
|
- $ref: '#/components/schemas/FaceEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
parent_device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContextStatusEnum'
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv4
|
|
primary_ip6:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv6
|
|
secrets_group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
cluster:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
virtual_chassis:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vc_position:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
vc_priority:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
local_context_schema:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optional schema to validate the structure of the data
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
config_context:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableFrontPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
rear_port:
|
|
type: string
|
|
format: uuid
|
|
rear_port_position:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
default: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableFrontPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
rear_port:
|
|
type: string
|
|
format: uuid
|
|
rear_port_position:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
default: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableGitRepository:
|
|
type: object
|
|
description: Git repositories defined as a data source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
remote_url:
|
|
type: string
|
|
format: uri
|
|
description: Only HTTP and HTTPS URLs are presently supported
|
|
maxLength: 255
|
|
branch:
|
|
type: string
|
|
maxLength: 64
|
|
token:
|
|
type: string
|
|
writeOnly: true
|
|
username:
|
|
type: string
|
|
maxLength: 64
|
|
secrets_group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
current_head:
|
|
type: string
|
|
description: Commit hash of the most recent fetch from the selected branch.
|
|
Used for syncing between workers.
|
|
maxLength: 48
|
|
provided_contents:
|
|
type: array
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ProvidedContentsEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableHardwareLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
devices:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
description: Devices tied to Device Type
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
inventory_item:
|
|
type: string
|
|
nullable: true
|
|
title: Inventory Item Part
|
|
maxLength: 255
|
|
release_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_sale:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_sw_releases:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Releases
|
|
end_of_security_patches:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
documentation_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableIPAddress:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FamilyEnum'
|
|
readOnly: true
|
|
address:
|
|
type: string
|
|
vrf:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableIPAddressStatusEnum'
|
|
role:
|
|
description: The functional role of this IP
|
|
oneOf:
|
|
- $ref: '#/components/schemas/RoleEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
assigned_object_type:
|
|
type: string
|
|
nullable: true
|
|
assigned_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
assigned_object:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
nat_inside:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: NAT (Inside)
|
|
description: The IP Addresses for which this address is the "outside" IP
|
|
nat_outside:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
dns_name:
|
|
type: string
|
|
description: Hostname or FQDN (not case-sensitive)
|
|
pattern: ^[0-9A-Za-z._-]+$
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableInterface:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/InterfaceTypeChoices'
|
|
enabled:
|
|
type: boolean
|
|
lag:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Parent LAG
|
|
mtu:
|
|
type: integer
|
|
maximum: 65536
|
|
minimum: 1
|
|
nullable: true
|
|
mac_address:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 18
|
|
mgmt_only:
|
|
type: boolean
|
|
title: Management only
|
|
description: This interface is used only for out-of-band management
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
mode:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ModeEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
untagged_vlan:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tagged_vlans:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
title: Tagged VLANs
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
count_ipaddresses:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableInterfaceTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/InterfaceTypeChoices'
|
|
mgmt_only:
|
|
type: boolean
|
|
title: Management only
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableInventoryItem:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
manufacturer:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
part_id:
|
|
type: string
|
|
description: Manufacturer-assigned part identifier
|
|
maxLength: 50
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this item
|
|
maxLength: 50
|
|
discovered:
|
|
type: boolean
|
|
description: This item was automatically discovered
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableObjectPermission:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
enabled:
|
|
type: boolean
|
|
object_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
groups:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
users:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
actions:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: The list of actions granted by this permission
|
|
constraints:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable objects of the selected
|
|
type(s)
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePlatform:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
manufacturer:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optionally limit this platform to devices of a certain manufacturer
|
|
napalm_driver:
|
|
type: string
|
|
description: The name of the NAPALM driver to use when interacting with
|
|
devices
|
|
maxLength: 50
|
|
napalm_args:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
title: NAPALM arguments
|
|
description: Additional arguments to pass when initiating the NAPALM driver
|
|
(JSON format)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePowerFeed:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
power_panel:
|
|
type: string
|
|
format: uuid
|
|
rack:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
status:
|
|
$ref: '#/components/schemas/WritablePowerFeedStatusEnum'
|
|
type:
|
|
$ref: '#/components/schemas/PowerFeedTypeChoices'
|
|
supply:
|
|
$ref: '#/components/schemas/SupplyEnum'
|
|
phase:
|
|
$ref: '#/components/schemas/PhaseEnum'
|
|
voltage:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: -32768
|
|
amperage:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
max_utilization:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
description: Maximum permissible draw (percentage)
|
|
comments:
|
|
type: string
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePowerOutlet:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerOutletTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
power_port:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
feed_leg:
|
|
description: Phase (for three-phase feeds)
|
|
oneOf:
|
|
- $ref: '#/components/schemas/FeedLegEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePowerOutletTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerOutletTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
power_port:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
feed_leg:
|
|
description: Phase (for three-phase feeds)
|
|
oneOf:
|
|
- $ref: '#/components/schemas/FeedLegEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePowerPanel:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
rack_group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePowerPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerPortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
maximum_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Maximum power draw (watts)
|
|
allocated_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Allocated power draw (watts)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePowerPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerPortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
maximum_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Maximum power draw (watts)
|
|
allocated_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Allocated power draw (watts)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritablePrefix:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FamilyEnum'
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vrf:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vlan:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritablePrefixStatusEnum'
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: The primary function of this prefix
|
|
is_pool:
|
|
type: boolean
|
|
title: Is a pool
|
|
description: All IP addresses within this prefix are considered usable
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableProviderNetwork:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
provider:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRack:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
facility_id:
|
|
type: string
|
|
nullable: true
|
|
description: Locally-assigned identifier
|
|
maxLength: 50
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Assigned group
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableRackStatusEnum'
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Functional role
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this rack
|
|
maxLength: 50
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/RackTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
width:
|
|
allOf:
|
|
- $ref: '#/components/schemas/WidthEnum'
|
|
description: Rail-to-rail width
|
|
minimum: 0
|
|
maximum: 32767
|
|
u_height:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
title: Height (U)
|
|
description: Height in rack units
|
|
desc_units:
|
|
type: boolean
|
|
title: Descending units
|
|
description: Units are numbered top-to-bottom
|
|
outer_width:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
description: Outer dimension of rack (width)
|
|
outer_depth:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
description: Outer dimension of rack (depth)
|
|
outer_unit:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OuterUnitEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRackGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRackReservation:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
rack:
|
|
type: string
|
|
format: uuid
|
|
units:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
user:
|
|
type: string
|
|
format: uuid
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRearPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
positions:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRearPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
positions:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRegion:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableRelationshipAssociation:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
relationship:
|
|
type: string
|
|
format: uuid
|
|
source_type:
|
|
type: string
|
|
source_id:
|
|
type: string
|
|
format: uuid
|
|
destination_type:
|
|
type: string
|
|
destination_id:
|
|
type: string
|
|
format: uuid
|
|
PatchedWritableRouteTarget:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Route target value (formatted in accordance with RFC 4360)
|
|
maxLength: 21
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableSecretsGroupAssociation:
|
|
type: object
|
|
description: Serializer for `SecretsGroupAssociation` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
access_type:
|
|
$ref: '#/components/schemas/AccessTypeEnum'
|
|
secret_type:
|
|
$ref: '#/components/schemas/SecretTypeEnum'
|
|
secret:
|
|
type: string
|
|
format: uuid
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableService:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
virtual_machine:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
ports:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 1
|
|
protocol:
|
|
$ref: '#/components/schemas/ProtocolEnum'
|
|
ipaddresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
title: IP addresses
|
|
title: IP addresses
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableSite:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
status:
|
|
$ref: '#/components/schemas/WritableSiteStatusEnum'
|
|
region:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
facility:
|
|
type: string
|
|
description: Local facility ID or description
|
|
maxLength: 50
|
|
asn:
|
|
type: integer
|
|
maximum: 4294967295
|
|
minimum: 1
|
|
format: int64
|
|
nullable: true
|
|
description: 32-bit autonomous system number
|
|
time_zone:
|
|
type: string
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
physical_address:
|
|
type: string
|
|
maxLength: 200
|
|
shipping_address:
|
|
type: string
|
|
maxLength: 200
|
|
latitude:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,2}(?:\.\d{0,6})?$
|
|
nullable: true
|
|
description: GPS coordinate (latitude)
|
|
longitude:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,3}(?:\.\d{0,6})?$
|
|
nullable: true
|
|
description: GPS coordinate (longitude)
|
|
contact_name:
|
|
type: string
|
|
maxLength: 50
|
|
contact_phone:
|
|
type: string
|
|
maxLength: 20
|
|
contact_email:
|
|
type: string
|
|
format: email
|
|
title: Contact E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableSoftwareImageLCM:
|
|
type: object
|
|
description: REST API serializer for SoftwareImageLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
image_file_name:
|
|
type: string
|
|
maxLength: 100
|
|
software:
|
|
type: string
|
|
format: uuid
|
|
title: Software Version
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
download_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
image_file_checksum:
|
|
type: string
|
|
maxLength: 256
|
|
default_image:
|
|
type: boolean
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableSoftwareLCM:
|
|
type: object
|
|
description: REST API serializer for SoftwareLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_platform:
|
|
type: string
|
|
format: uuid
|
|
version:
|
|
type: string
|
|
maxLength: 50
|
|
alias:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 50
|
|
release_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Support
|
|
documentation_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
software_images:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
long_term_support:
|
|
type: boolean
|
|
pre_release:
|
|
type: boolean
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableTenant:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
ipaddress_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
vrf_count:
|
|
type: integer
|
|
readOnly: true
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableTenantGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tenant_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableUser:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
username:
|
|
type: string
|
|
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
|
|
only.
|
|
pattern: ^[\w.@+-]+$
|
|
maxLength: 150
|
|
password:
|
|
type: string
|
|
writeOnly: true
|
|
maxLength: 128
|
|
first_name:
|
|
type: string
|
|
maxLength: 150
|
|
last_name:
|
|
type: string
|
|
maxLength: 150
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: Email address
|
|
maxLength: 254
|
|
is_staff:
|
|
type: boolean
|
|
title: Staff status
|
|
description: Designates whether the user can log into this admin site.
|
|
is_active:
|
|
type: boolean
|
|
title: Active
|
|
description: Designates whether this user should be treated as active. Unselect
|
|
this instead of deleting accounts.
|
|
date_joined:
|
|
type: string
|
|
format: date-time
|
|
groups:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: The groups this user belongs to. A user will get all permissions
|
|
granted to each of their groups.
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableVLAN:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vid:
|
|
type: integer
|
|
maximum: 4094
|
|
minimum: 1
|
|
title: ID
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableVLANStatusEnum'
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableVLANGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableVMInterface:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
virtual_machine:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
enabled:
|
|
type: boolean
|
|
mtu:
|
|
type: integer
|
|
maximum: 65536
|
|
minimum: 1
|
|
nullable: true
|
|
mac_address:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 18
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
mode:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ModeEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
untagged_vlan:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tagged_vlans:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
title: Tagged VLANs
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableVRF:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
rd:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Unique route distinguisher (as defined in RFC 4364)
|
|
maxLength: 21
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
enforce_unique:
|
|
type: boolean
|
|
title: Enforce unique space
|
|
description: Prevent duplicate prefixes/IP addresses within this VRF
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
import_targets:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
export_targets:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
ipaddress_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableValidatedSoftwareLCM:
|
|
type: object
|
|
description: REST API serializer for ValidatedSoftwareLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
software:
|
|
type: string
|
|
format: uuid
|
|
title: Software Version
|
|
devices:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_roles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
start:
|
|
type: string
|
|
format: date
|
|
title: Valid Since
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Valid Until
|
|
preferred:
|
|
type: boolean
|
|
title: Preferred Version
|
|
valid:
|
|
type: string
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableVirtualChassis:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
domain:
|
|
type: string
|
|
maxLength: 30
|
|
master:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
member_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PatchedWritableVirtualMachineWithConfigContext:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
status:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContextStatusEnum'
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
readOnly: true
|
|
cluster:
|
|
type: string
|
|
format: uuid
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv4
|
|
primary_ip6:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv6
|
|
vcpus:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
memory:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Memory (MB)
|
|
disk:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Disk (GB)
|
|
comments:
|
|
type: string
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
local_context_schema:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optional schema to validate the structure of the data
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
config_context:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
PhaseEnum:
|
|
enum:
|
|
- single-phase
|
|
- three-phase
|
|
type: string
|
|
Platform:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
manufacturer:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedManufacturer'
|
|
nullable: true
|
|
napalm_driver:
|
|
type: string
|
|
description: The name of the NAPALM driver to use when interacting with
|
|
devices
|
|
maxLength: 50
|
|
napalm_args:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
title: NAPALM arguments
|
|
description: Additional arguments to pass when initiating the NAPALM driver
|
|
(JSON format)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
PlatformEnum:
|
|
enum:
|
|
- mattermost
|
|
type: string
|
|
PortTypeChoices:
|
|
enum:
|
|
- 8p8c
|
|
- 8p6c
|
|
- 8p4c
|
|
- 8p2c
|
|
- gg45
|
|
- tera-4p
|
|
- tera-2p
|
|
- tera-1p
|
|
- 110-punch
|
|
- bnc
|
|
- mrj21
|
|
- fc
|
|
- lc
|
|
- lc-apc
|
|
- lsh
|
|
- lsh-apc
|
|
- mpo
|
|
- mtrj
|
|
- sc
|
|
- sc-apc
|
|
- st
|
|
- cs
|
|
- sn
|
|
- urm-p2
|
|
- urm-p4
|
|
- urm-p8
|
|
- splice
|
|
type: string
|
|
PowerFeed:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
power_panel:
|
|
$ref: '#/components/schemas/NestedPowerPanel'
|
|
rack:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRack'
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- failed
|
|
- offline
|
|
- planned
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Failed
|
|
- Offline
|
|
- Planned
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- primary
|
|
- redundant
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Primary
|
|
- Redundant
|
|
default:
|
|
value: primary
|
|
label: Primary
|
|
supply:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- ac
|
|
- dc
|
|
label:
|
|
type: string
|
|
enum:
|
|
- AC
|
|
- DC
|
|
default:
|
|
value: ac
|
|
label: AC
|
|
phase:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- single-phase
|
|
- three-phase
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Single phase
|
|
- Three-phase
|
|
default:
|
|
value: single-phase
|
|
label: Single phase
|
|
voltage:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: -32768
|
|
amperage:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
max_utilization:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
description: Maximum permissible draw (percentage)
|
|
comments:
|
|
type: string
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- power_panel
|
|
- status
|
|
- url
|
|
PowerFeedTypeChoices:
|
|
enum:
|
|
- primary
|
|
- redundant
|
|
type: string
|
|
PowerOutlet:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- iec-60320-c5
|
|
- iec-60320-c7
|
|
- iec-60320-c13
|
|
- iec-60320-c15
|
|
- iec-60320-c19
|
|
- iec-60309-p-n-e-4h
|
|
- iec-60309-p-n-e-6h
|
|
- iec-60309-p-n-e-9h
|
|
- iec-60309-2p-e-4h
|
|
- iec-60309-2p-e-6h
|
|
- iec-60309-2p-e-9h
|
|
- iec-60309-3p-e-4h
|
|
- iec-60309-3p-e-6h
|
|
- iec-60309-3p-e-9h
|
|
- iec-60309-3p-n-e-4h
|
|
- iec-60309-3p-n-e-6h
|
|
- iec-60309-3p-n-e-9h
|
|
- nema-1-15r
|
|
- nema-5-15r
|
|
- nema-5-20r
|
|
- nema-5-30r
|
|
- nema-5-50r
|
|
- nema-6-15r
|
|
- nema-6-20r
|
|
- nema-6-30r
|
|
- nema-6-50r
|
|
- nema-10-30r
|
|
- nema-10-50r
|
|
- nema-14-20r
|
|
- nema-14-30r
|
|
- nema-14-50r
|
|
- nema-14-60r
|
|
- nema-15-15r
|
|
- nema-15-20r
|
|
- nema-15-30r
|
|
- nema-15-50r
|
|
- nema-15-60r
|
|
- nema-l1-15r
|
|
- nema-l5-15r
|
|
- nema-l5-20r
|
|
- nema-l5-30r
|
|
- nema-l5-50r
|
|
- nema-l6-15r
|
|
- nema-l6-20r
|
|
- nema-l6-30r
|
|
- nema-l6-50r
|
|
- nema-l10-30r
|
|
- nema-l14-20r
|
|
- nema-l14-30r
|
|
- nema-l14-50r
|
|
- nema-l14-60r
|
|
- nema-l15-20r
|
|
- nema-l15-30r
|
|
- nema-l15-50r
|
|
- nema-l15-60r
|
|
- nema-l21-20r
|
|
- nema-l21-30r
|
|
- CS6360C
|
|
- CS6364C
|
|
- CS8164C
|
|
- CS8264C
|
|
- CS8364C
|
|
- CS8464C
|
|
- ita-e
|
|
- ita-f
|
|
- ita-g
|
|
- ita-h
|
|
- ita-i
|
|
- ita-j
|
|
- ita-k
|
|
- ita-l
|
|
- ita-m
|
|
- ita-n
|
|
- ita-o
|
|
- usb-a
|
|
- usb-micro-b
|
|
- usb-c
|
|
- hdot-cx
|
|
label:
|
|
type: string
|
|
enum:
|
|
- C5
|
|
- C7
|
|
- C13
|
|
- C15
|
|
- C19
|
|
- P+N+E 4H
|
|
- P+N+E 6H
|
|
- P+N+E 9H
|
|
- 2P+E 4H
|
|
- 2P+E 6H
|
|
- 2P+E 9H
|
|
- 3P+E 4H
|
|
- 3P+E 6H
|
|
- 3P+E 9H
|
|
- 3P+N+E 4H
|
|
- 3P+N+E 6H
|
|
- 3P+N+E 9H
|
|
- NEMA 1-15R
|
|
- NEMA 5-15R
|
|
- NEMA 5-20R
|
|
- NEMA 5-30R
|
|
- NEMA 5-50R
|
|
- NEMA 6-15R
|
|
- NEMA 6-20R
|
|
- NEMA 6-30R
|
|
- NEMA 6-50R
|
|
- NEMA 10-30R
|
|
- NEMA 10-50R
|
|
- NEMA 14-20R
|
|
- NEMA 14-30R
|
|
- NEMA 14-50R
|
|
- NEMA 14-60R
|
|
- NEMA 15-15R
|
|
- NEMA 15-20R
|
|
- NEMA 15-30R
|
|
- NEMA 15-50R
|
|
- NEMA 15-60R
|
|
- NEMA L1-15R
|
|
- NEMA L5-15R
|
|
- NEMA L5-20R
|
|
- NEMA L5-30R
|
|
- NEMA L5-50R
|
|
- NEMA L6-15R
|
|
- NEMA L6-20R
|
|
- NEMA L6-30R
|
|
- NEMA L6-50R
|
|
- NEMA L10-30R
|
|
- NEMA L14-20R
|
|
- NEMA L14-30R
|
|
- NEMA L14-50R
|
|
- NEMA L14-60R
|
|
- NEMA L15-20R
|
|
- NEMA L15-30R
|
|
- NEMA L15-50R
|
|
- NEMA L15-60R
|
|
- NEMA L21-20R
|
|
- NEMA L21-30R
|
|
- CS6360C
|
|
- CS6364C
|
|
- CS8164C
|
|
- CS8264C
|
|
- CS8364C
|
|
- CS8464C
|
|
- ITA Type E (CEE7/5)
|
|
- ITA Type F (CEE7/3)
|
|
- ITA Type G (BS 1363)
|
|
- ITA Type H
|
|
- ITA Type I
|
|
- ITA Type J
|
|
- ITA Type K
|
|
- ITA Type L (CEI 23-50)
|
|
- ITA Type M (BS 546)
|
|
- ITA Type N
|
|
- ITA Type O
|
|
- USB Type A
|
|
- USB Micro B
|
|
- USB Type C
|
|
- HDOT Cx
|
|
power_port:
|
|
$ref: '#/components/schemas/NestedPowerPort'
|
|
feed_leg:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- A
|
|
- B
|
|
- C
|
|
label:
|
|
type: string
|
|
enum:
|
|
- A
|
|
- B
|
|
- C
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
PowerOutletTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- iec-60320-c5
|
|
- iec-60320-c7
|
|
- iec-60320-c13
|
|
- iec-60320-c15
|
|
- iec-60320-c19
|
|
- iec-60309-p-n-e-4h
|
|
- iec-60309-p-n-e-6h
|
|
- iec-60309-p-n-e-9h
|
|
- iec-60309-2p-e-4h
|
|
- iec-60309-2p-e-6h
|
|
- iec-60309-2p-e-9h
|
|
- iec-60309-3p-e-4h
|
|
- iec-60309-3p-e-6h
|
|
- iec-60309-3p-e-9h
|
|
- iec-60309-3p-n-e-4h
|
|
- iec-60309-3p-n-e-6h
|
|
- iec-60309-3p-n-e-9h
|
|
- nema-1-15r
|
|
- nema-5-15r
|
|
- nema-5-20r
|
|
- nema-5-30r
|
|
- nema-5-50r
|
|
- nema-6-15r
|
|
- nema-6-20r
|
|
- nema-6-30r
|
|
- nema-6-50r
|
|
- nema-10-30r
|
|
- nema-10-50r
|
|
- nema-14-20r
|
|
- nema-14-30r
|
|
- nema-14-50r
|
|
- nema-14-60r
|
|
- nema-15-15r
|
|
- nema-15-20r
|
|
- nema-15-30r
|
|
- nema-15-50r
|
|
- nema-15-60r
|
|
- nema-l1-15r
|
|
- nema-l5-15r
|
|
- nema-l5-20r
|
|
- nema-l5-30r
|
|
- nema-l5-50r
|
|
- nema-l6-15r
|
|
- nema-l6-20r
|
|
- nema-l6-30r
|
|
- nema-l6-50r
|
|
- nema-l10-30r
|
|
- nema-l14-20r
|
|
- nema-l14-30r
|
|
- nema-l14-50r
|
|
- nema-l14-60r
|
|
- nema-l15-20r
|
|
- nema-l15-30r
|
|
- nema-l15-50r
|
|
- nema-l15-60r
|
|
- nema-l21-20r
|
|
- nema-l21-30r
|
|
- CS6360C
|
|
- CS6364C
|
|
- CS8164C
|
|
- CS8264C
|
|
- CS8364C
|
|
- CS8464C
|
|
- ita-e
|
|
- ita-f
|
|
- ita-g
|
|
- ita-h
|
|
- ita-i
|
|
- ita-j
|
|
- ita-k
|
|
- ita-l
|
|
- ita-m
|
|
- ita-n
|
|
- ita-o
|
|
- usb-a
|
|
- usb-micro-b
|
|
- usb-c
|
|
- hdot-cx
|
|
label:
|
|
type: string
|
|
enum:
|
|
- C5
|
|
- C7
|
|
- C13
|
|
- C15
|
|
- C19
|
|
- P+N+E 4H
|
|
- P+N+E 6H
|
|
- P+N+E 9H
|
|
- 2P+E 4H
|
|
- 2P+E 6H
|
|
- 2P+E 9H
|
|
- 3P+E 4H
|
|
- 3P+E 6H
|
|
- 3P+E 9H
|
|
- 3P+N+E 4H
|
|
- 3P+N+E 6H
|
|
- 3P+N+E 9H
|
|
- NEMA 1-15R
|
|
- NEMA 5-15R
|
|
- NEMA 5-20R
|
|
- NEMA 5-30R
|
|
- NEMA 5-50R
|
|
- NEMA 6-15R
|
|
- NEMA 6-20R
|
|
- NEMA 6-30R
|
|
- NEMA 6-50R
|
|
- NEMA 10-30R
|
|
- NEMA 10-50R
|
|
- NEMA 14-20R
|
|
- NEMA 14-30R
|
|
- NEMA 14-50R
|
|
- NEMA 14-60R
|
|
- NEMA 15-15R
|
|
- NEMA 15-20R
|
|
- NEMA 15-30R
|
|
- NEMA 15-50R
|
|
- NEMA 15-60R
|
|
- NEMA L1-15R
|
|
- NEMA L5-15R
|
|
- NEMA L5-20R
|
|
- NEMA L5-30R
|
|
- NEMA L5-50R
|
|
- NEMA L6-15R
|
|
- NEMA L6-20R
|
|
- NEMA L6-30R
|
|
- NEMA L6-50R
|
|
- NEMA L10-30R
|
|
- NEMA L14-20R
|
|
- NEMA L14-30R
|
|
- NEMA L14-50R
|
|
- NEMA L14-60R
|
|
- NEMA L15-20R
|
|
- NEMA L15-30R
|
|
- NEMA L15-50R
|
|
- NEMA L15-60R
|
|
- NEMA L21-20R
|
|
- NEMA L21-30R
|
|
- CS6360C
|
|
- CS6364C
|
|
- CS8164C
|
|
- CS8264C
|
|
- CS8364C
|
|
- CS8464C
|
|
- ITA Type E (CEE7/5)
|
|
- ITA Type F (CEE7/3)
|
|
- ITA Type G (BS 1363)
|
|
- ITA Type H
|
|
- ITA Type I
|
|
- ITA Type J
|
|
- ITA Type K
|
|
- ITA Type L (CEI 23-50)
|
|
- ITA Type M (BS 546)
|
|
- ITA Type N
|
|
- ITA Type O
|
|
- USB Type A
|
|
- USB Micro B
|
|
- USB Type C
|
|
- HDOT Cx
|
|
power_port:
|
|
$ref: '#/components/schemas/NestedPowerPortTemplate'
|
|
feed_leg:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- A
|
|
- B
|
|
- C
|
|
label:
|
|
type: string
|
|
enum:
|
|
- A
|
|
- B
|
|
- C
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
PowerOutletTypeChoices:
|
|
enum:
|
|
- iec-60320-c5
|
|
- iec-60320-c7
|
|
- iec-60320-c13
|
|
- iec-60320-c15
|
|
- iec-60320-c19
|
|
- iec-60309-p-n-e-4h
|
|
- iec-60309-p-n-e-6h
|
|
- iec-60309-p-n-e-9h
|
|
- iec-60309-2p-e-4h
|
|
- iec-60309-2p-e-6h
|
|
- iec-60309-2p-e-9h
|
|
- iec-60309-3p-e-4h
|
|
- iec-60309-3p-e-6h
|
|
- iec-60309-3p-e-9h
|
|
- iec-60309-3p-n-e-4h
|
|
- iec-60309-3p-n-e-6h
|
|
- iec-60309-3p-n-e-9h
|
|
- nema-1-15r
|
|
- nema-5-15r
|
|
- nema-5-20r
|
|
- nema-5-30r
|
|
- nema-5-50r
|
|
- nema-6-15r
|
|
- nema-6-20r
|
|
- nema-6-30r
|
|
- nema-6-50r
|
|
- nema-10-30r
|
|
- nema-10-50r
|
|
- nema-14-20r
|
|
- nema-14-30r
|
|
- nema-14-50r
|
|
- nema-14-60r
|
|
- nema-15-15r
|
|
- nema-15-20r
|
|
- nema-15-30r
|
|
- nema-15-50r
|
|
- nema-15-60r
|
|
- nema-l1-15r
|
|
- nema-l5-15r
|
|
- nema-l5-20r
|
|
- nema-l5-30r
|
|
- nema-l5-50r
|
|
- nema-l6-15r
|
|
- nema-l6-20r
|
|
- nema-l6-30r
|
|
- nema-l6-50r
|
|
- nema-l10-30r
|
|
- nema-l14-20r
|
|
- nema-l14-30r
|
|
- nema-l14-50r
|
|
- nema-l14-60r
|
|
- nema-l15-20r
|
|
- nema-l15-30r
|
|
- nema-l15-50r
|
|
- nema-l15-60r
|
|
- nema-l21-20r
|
|
- nema-l21-30r
|
|
- CS6360C
|
|
- CS6364C
|
|
- CS8164C
|
|
- CS8264C
|
|
- CS8364C
|
|
- CS8464C
|
|
- ita-e
|
|
- ita-f
|
|
- ita-g
|
|
- ita-h
|
|
- ita-i
|
|
- ita-j
|
|
- ita-k
|
|
- ita-l
|
|
- ita-m
|
|
- ita-n
|
|
- ita-o
|
|
- usb-a
|
|
- usb-micro-b
|
|
- usb-c
|
|
- hdot-cx
|
|
type: string
|
|
PowerPanel:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
$ref: '#/components/schemas/NestedSite'
|
|
rack_group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRackGroup'
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- powerfeed_count
|
|
- site
|
|
- url
|
|
PowerPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- iec-60320-c6
|
|
- iec-60320-c8
|
|
- iec-60320-c14
|
|
- iec-60320-c16
|
|
- iec-60320-c20
|
|
- iec-60309-p-n-e-4h
|
|
- iec-60309-p-n-e-6h
|
|
- iec-60309-p-n-e-9h
|
|
- iec-60309-2p-e-4h
|
|
- iec-60309-2p-e-6h
|
|
- iec-60309-2p-e-9h
|
|
- iec-60309-3p-e-4h
|
|
- iec-60309-3p-e-6h
|
|
- iec-60309-3p-e-9h
|
|
- iec-60309-3p-n-e-4h
|
|
- iec-60309-3p-n-e-6h
|
|
- iec-60309-3p-n-e-9h
|
|
- nema-1-15p
|
|
- nema-5-15p
|
|
- nema-5-20p
|
|
- nema-5-30p
|
|
- nema-5-50p
|
|
- nema-6-15p
|
|
- nema-6-20p
|
|
- nema-6-30p
|
|
- nema-6-50p
|
|
- nema-10-30p
|
|
- nema-10-50p
|
|
- nema-14-20p
|
|
- nema-14-30p
|
|
- nema-14-50p
|
|
- nema-14-60p
|
|
- nema-15-15p
|
|
- nema-15-20p
|
|
- nema-15-30p
|
|
- nema-15-50p
|
|
- nema-15-60p
|
|
- nema-l1-15p
|
|
- nema-l5-15p
|
|
- nema-l5-20p
|
|
- nema-l5-30p
|
|
- nema-l5-50p
|
|
- nema-l6-15p
|
|
- nema-l6-20p
|
|
- nema-l6-30p
|
|
- nema-l6-50p
|
|
- nema-l10-30p
|
|
- nema-l14-20p
|
|
- nema-l14-30p
|
|
- nema-l14-50p
|
|
- nema-l14-60p
|
|
- nema-l15-20p
|
|
- nema-l15-30p
|
|
- nema-l15-50p
|
|
- nema-l15-60p
|
|
- nema-l21-20p
|
|
- nema-l21-30p
|
|
- cs6361c
|
|
- cs6365c
|
|
- cs8165c
|
|
- cs8265c
|
|
- cs8365c
|
|
- cs8465c
|
|
- ita-e
|
|
- ita-f
|
|
- ita-ef
|
|
- ita-g
|
|
- ita-h
|
|
- ita-i
|
|
- ita-j
|
|
- ita-k
|
|
- ita-l
|
|
- ita-m
|
|
- ita-n
|
|
- ita-o
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- usb-3-b
|
|
- usb-3-micro-b
|
|
label:
|
|
type: string
|
|
enum:
|
|
- C6
|
|
- C8
|
|
- C14
|
|
- C16
|
|
- C20
|
|
- P+N+E 4H
|
|
- P+N+E 6H
|
|
- P+N+E 9H
|
|
- 2P+E 4H
|
|
- 2P+E 6H
|
|
- 2P+E 9H
|
|
- 3P+E 4H
|
|
- 3P+E 6H
|
|
- 3P+E 9H
|
|
- 3P+N+E 4H
|
|
- 3P+N+E 6H
|
|
- 3P+N+E 9H
|
|
- NEMA 1-15P
|
|
- NEMA 5-15P
|
|
- NEMA 5-20P
|
|
- NEMA 5-30P
|
|
- NEMA 5-50P
|
|
- NEMA 6-15P
|
|
- NEMA 6-20P
|
|
- NEMA 6-30P
|
|
- NEMA 6-50P
|
|
- NEMA 10-30P
|
|
- NEMA 10-50P
|
|
- NEMA 14-20P
|
|
- NEMA 14-30P
|
|
- NEMA 14-50P
|
|
- NEMA 14-60P
|
|
- NEMA 15-15P
|
|
- NEMA 15-20P
|
|
- NEMA 15-30P
|
|
- NEMA 15-50P
|
|
- NEMA 15-60P
|
|
- NEMA L1-15P
|
|
- NEMA L5-15P
|
|
- NEMA L5-20P
|
|
- NEMA L5-30P
|
|
- NEMA L5-50P
|
|
- NEMA L6-15P
|
|
- NEMA L6-20P
|
|
- NEMA L6-30P
|
|
- NEMA L6-50P
|
|
- NEMA L10-30P
|
|
- NEMA L14-20P
|
|
- NEMA L14-30P
|
|
- NEMA L14-50P
|
|
- NEMA L14-60P
|
|
- NEMA L15-20P
|
|
- NEMA L15-30P
|
|
- NEMA L15-50P
|
|
- NEMA L15-60P
|
|
- NEMA L21-20P
|
|
- NEMA L21-30P
|
|
- CS6361C
|
|
- CS6365C
|
|
- CS8165C
|
|
- CS8265C
|
|
- CS8365C
|
|
- CS8465C
|
|
- ITA Type E (CEE 7/5)
|
|
- ITA Type F (CEE 7/4)
|
|
- ITA Type E/F (CEE 7/7)
|
|
- ITA Type G (BS 1363)
|
|
- ITA Type H
|
|
- ITA Type I
|
|
- ITA Type J
|
|
- ITA Type K
|
|
- ITA Type L (CEI 23-50)
|
|
- ITA Type M (BS 546)
|
|
- ITA Type N
|
|
- ITA Type O
|
|
- USB Type A
|
|
- USB Type B
|
|
- USB Type C
|
|
- USB Mini A
|
|
- USB Mini B
|
|
- USB Micro A
|
|
- USB Micro B
|
|
- USB 3.0 Type B
|
|
- USB 3.0 Micro B
|
|
maximum_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Maximum power draw (watts)
|
|
allocated_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Allocated power draw (watts)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
PowerPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- iec-60320-c6
|
|
- iec-60320-c8
|
|
- iec-60320-c14
|
|
- iec-60320-c16
|
|
- iec-60320-c20
|
|
- iec-60309-p-n-e-4h
|
|
- iec-60309-p-n-e-6h
|
|
- iec-60309-p-n-e-9h
|
|
- iec-60309-2p-e-4h
|
|
- iec-60309-2p-e-6h
|
|
- iec-60309-2p-e-9h
|
|
- iec-60309-3p-e-4h
|
|
- iec-60309-3p-e-6h
|
|
- iec-60309-3p-e-9h
|
|
- iec-60309-3p-n-e-4h
|
|
- iec-60309-3p-n-e-6h
|
|
- iec-60309-3p-n-e-9h
|
|
- nema-1-15p
|
|
- nema-5-15p
|
|
- nema-5-20p
|
|
- nema-5-30p
|
|
- nema-5-50p
|
|
- nema-6-15p
|
|
- nema-6-20p
|
|
- nema-6-30p
|
|
- nema-6-50p
|
|
- nema-10-30p
|
|
- nema-10-50p
|
|
- nema-14-20p
|
|
- nema-14-30p
|
|
- nema-14-50p
|
|
- nema-14-60p
|
|
- nema-15-15p
|
|
- nema-15-20p
|
|
- nema-15-30p
|
|
- nema-15-50p
|
|
- nema-15-60p
|
|
- nema-l1-15p
|
|
- nema-l5-15p
|
|
- nema-l5-20p
|
|
- nema-l5-30p
|
|
- nema-l5-50p
|
|
- nema-l6-15p
|
|
- nema-l6-20p
|
|
- nema-l6-30p
|
|
- nema-l6-50p
|
|
- nema-l10-30p
|
|
- nema-l14-20p
|
|
- nema-l14-30p
|
|
- nema-l14-50p
|
|
- nema-l14-60p
|
|
- nema-l15-20p
|
|
- nema-l15-30p
|
|
- nema-l15-50p
|
|
- nema-l15-60p
|
|
- nema-l21-20p
|
|
- nema-l21-30p
|
|
- cs6361c
|
|
- cs6365c
|
|
- cs8165c
|
|
- cs8265c
|
|
- cs8365c
|
|
- cs8465c
|
|
- ita-e
|
|
- ita-f
|
|
- ita-ef
|
|
- ita-g
|
|
- ita-h
|
|
- ita-i
|
|
- ita-j
|
|
- ita-k
|
|
- ita-l
|
|
- ita-m
|
|
- ita-n
|
|
- ita-o
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- usb-3-b
|
|
- usb-3-micro-b
|
|
label:
|
|
type: string
|
|
enum:
|
|
- C6
|
|
- C8
|
|
- C14
|
|
- C16
|
|
- C20
|
|
- P+N+E 4H
|
|
- P+N+E 6H
|
|
- P+N+E 9H
|
|
- 2P+E 4H
|
|
- 2P+E 6H
|
|
- 2P+E 9H
|
|
- 3P+E 4H
|
|
- 3P+E 6H
|
|
- 3P+E 9H
|
|
- 3P+N+E 4H
|
|
- 3P+N+E 6H
|
|
- 3P+N+E 9H
|
|
- NEMA 1-15P
|
|
- NEMA 5-15P
|
|
- NEMA 5-20P
|
|
- NEMA 5-30P
|
|
- NEMA 5-50P
|
|
- NEMA 6-15P
|
|
- NEMA 6-20P
|
|
- NEMA 6-30P
|
|
- NEMA 6-50P
|
|
- NEMA 10-30P
|
|
- NEMA 10-50P
|
|
- NEMA 14-20P
|
|
- NEMA 14-30P
|
|
- NEMA 14-50P
|
|
- NEMA 14-60P
|
|
- NEMA 15-15P
|
|
- NEMA 15-20P
|
|
- NEMA 15-30P
|
|
- NEMA 15-50P
|
|
- NEMA 15-60P
|
|
- NEMA L1-15P
|
|
- NEMA L5-15P
|
|
- NEMA L5-20P
|
|
- NEMA L5-30P
|
|
- NEMA L5-50P
|
|
- NEMA L6-15P
|
|
- NEMA L6-20P
|
|
- NEMA L6-30P
|
|
- NEMA L6-50P
|
|
- NEMA L10-30P
|
|
- NEMA L14-20P
|
|
- NEMA L14-30P
|
|
- NEMA L14-50P
|
|
- NEMA L14-60P
|
|
- NEMA L15-20P
|
|
- NEMA L15-30P
|
|
- NEMA L15-50P
|
|
- NEMA L15-60P
|
|
- NEMA L21-20P
|
|
- NEMA L21-30P
|
|
- CS6361C
|
|
- CS6365C
|
|
- CS8165C
|
|
- CS8265C
|
|
- CS8365C
|
|
- CS8465C
|
|
- ITA Type E (CEE 7/5)
|
|
- ITA Type F (CEE 7/4)
|
|
- ITA Type E/F (CEE 7/7)
|
|
- ITA Type G (BS 1363)
|
|
- ITA Type H
|
|
- ITA Type I
|
|
- ITA Type J
|
|
- ITA Type K
|
|
- ITA Type L (CEI 23-50)
|
|
- ITA Type M (BS 546)
|
|
- ITA Type N
|
|
- ITA Type O
|
|
- USB Type A
|
|
- USB Type B
|
|
- USB Type C
|
|
- USB Mini A
|
|
- USB Mini B
|
|
- USB Micro A
|
|
- USB Micro B
|
|
- USB 3.0 Type B
|
|
- USB 3.0 Micro B
|
|
maximum_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Maximum power draw (watts)
|
|
allocated_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Allocated power draw (watts)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
PowerPortTypeChoices:
|
|
enum:
|
|
- iec-60320-c6
|
|
- iec-60320-c8
|
|
- iec-60320-c14
|
|
- iec-60320-c16
|
|
- iec-60320-c20
|
|
- iec-60309-p-n-e-4h
|
|
- iec-60309-p-n-e-6h
|
|
- iec-60309-p-n-e-9h
|
|
- iec-60309-2p-e-4h
|
|
- iec-60309-2p-e-6h
|
|
- iec-60309-2p-e-9h
|
|
- iec-60309-3p-e-4h
|
|
- iec-60309-3p-e-6h
|
|
- iec-60309-3p-e-9h
|
|
- iec-60309-3p-n-e-4h
|
|
- iec-60309-3p-n-e-6h
|
|
- iec-60309-3p-n-e-9h
|
|
- nema-1-15p
|
|
- nema-5-15p
|
|
- nema-5-20p
|
|
- nema-5-30p
|
|
- nema-5-50p
|
|
- nema-6-15p
|
|
- nema-6-20p
|
|
- nema-6-30p
|
|
- nema-6-50p
|
|
- nema-10-30p
|
|
- nema-10-50p
|
|
- nema-14-20p
|
|
- nema-14-30p
|
|
- nema-14-50p
|
|
- nema-14-60p
|
|
- nema-15-15p
|
|
- nema-15-20p
|
|
- nema-15-30p
|
|
- nema-15-50p
|
|
- nema-15-60p
|
|
- nema-l1-15p
|
|
- nema-l5-15p
|
|
- nema-l5-20p
|
|
- nema-l5-30p
|
|
- nema-l5-50p
|
|
- nema-l6-15p
|
|
- nema-l6-20p
|
|
- nema-l6-30p
|
|
- nema-l6-50p
|
|
- nema-l10-30p
|
|
- nema-l14-20p
|
|
- nema-l14-30p
|
|
- nema-l14-50p
|
|
- nema-l14-60p
|
|
- nema-l15-20p
|
|
- nema-l15-30p
|
|
- nema-l15-50p
|
|
- nema-l15-60p
|
|
- nema-l21-20p
|
|
- nema-l21-30p
|
|
- cs6361c
|
|
- cs6365c
|
|
- cs8165c
|
|
- cs8265c
|
|
- cs8365c
|
|
- cs8465c
|
|
- ita-e
|
|
- ita-f
|
|
- ita-ef
|
|
- ita-g
|
|
- ita-h
|
|
- ita-i
|
|
- ita-j
|
|
- ita-k
|
|
- ita-l
|
|
- ita-m
|
|
- ita-n
|
|
- ita-o
|
|
- usb-a
|
|
- usb-b
|
|
- usb-c
|
|
- usb-mini-a
|
|
- usb-mini-b
|
|
- usb-micro-a
|
|
- usb-micro-b
|
|
- usb-3-b
|
|
- usb-3-micro-b
|
|
type: string
|
|
Prefix:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: integer
|
|
enum:
|
|
- 4
|
|
- 6
|
|
label:
|
|
type: string
|
|
enum:
|
|
- IPv4
|
|
- IPv6
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
nullable: true
|
|
vrf:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVRF'
|
|
nullable: true
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
vlan:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVLAN'
|
|
nullable: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- container
|
|
- deprecated
|
|
- p2p
|
|
- reserved
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Container
|
|
- Deprecated
|
|
- Peer-to-Peer
|
|
- Reserved
|
|
role:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRole'
|
|
nullable: true
|
|
is_pool:
|
|
type: boolean
|
|
title: Is a pool
|
|
description: All IP addresses within this prefix are considered usable
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- family
|
|
- id
|
|
- last_updated
|
|
- prefix
|
|
- status
|
|
- url
|
|
PrefixLength:
|
|
type: object
|
|
properties:
|
|
prefix_length:
|
|
type: integer
|
|
required:
|
|
- prefix_length
|
|
ProtocolEnum:
|
|
enum:
|
|
- tcp
|
|
- udp
|
|
type: string
|
|
ProvidedContentsEnum:
|
|
enum:
|
|
- extras.configcontext
|
|
- extras.configcontextschema
|
|
- extras.exporttemplate
|
|
- extras.job
|
|
- nautobot_golden_config.backupconfigs
|
|
- nautobot_golden_config.intendedconfigs
|
|
- nautobot_golden_config.jinjatemplate
|
|
- nautobot_golden_config.pluginproperties
|
|
type: string
|
|
Provider:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
asn:
|
|
type: integer
|
|
maximum: 4294967295
|
|
minimum: 1
|
|
format: int64
|
|
nullable: true
|
|
description: 32-bit autonomous system number
|
|
account:
|
|
type: string
|
|
title: Account number
|
|
maxLength: 100
|
|
portal_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
noc_contact:
|
|
type: string
|
|
admin_contact:
|
|
type: string
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
ProviderLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
physical_address:
|
|
type: string
|
|
maxLength: 200
|
|
phone:
|
|
type: string
|
|
maxLength: 20
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
ProviderNetwork:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
provider:
|
|
$ref: '#/components/schemas/NestedProvider'
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- provider
|
|
- url
|
|
RIR:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
is_private:
|
|
type: boolean
|
|
title: Private
|
|
description: IP space managed by this RIR is considered private
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
aggregate_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- aggregate_count
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
Rack:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
facility_id:
|
|
type: string
|
|
nullable: true
|
|
description: Locally-assigned identifier
|
|
maxLength: 50
|
|
site:
|
|
$ref: '#/components/schemas/NestedSite'
|
|
group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRackGroup'
|
|
nullable: true
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- available
|
|
- deprecated
|
|
- planned
|
|
- reserved
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Available
|
|
- Deprecated
|
|
- Planned
|
|
- Reserved
|
|
role:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRackRole'
|
|
nullable: true
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this rack
|
|
maxLength: 50
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- 2-post-frame
|
|
- 4-post-frame
|
|
- 4-post-cabinet
|
|
- wall-frame
|
|
- wall-cabinet
|
|
label:
|
|
type: string
|
|
enum:
|
|
- 2-post frame
|
|
- 4-post frame
|
|
- 4-post cabinet
|
|
- Wall-mounted frame
|
|
- Wall-mounted cabinet
|
|
width:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: integer
|
|
enum:
|
|
- 10
|
|
- 19
|
|
- 21
|
|
- 23
|
|
label:
|
|
type: string
|
|
enum:
|
|
- 10 inches
|
|
- 19 inches
|
|
- 21 inches
|
|
- 23 inches
|
|
u_height:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
title: Height (U)
|
|
description: Height in rack units
|
|
desc_units:
|
|
type: boolean
|
|
title: Descending units
|
|
description: Units are numbered top-to-bottom
|
|
outer_width:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
description: Outer dimension of rack (width)
|
|
outer_depth:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
description: Outer dimension of rack (depth)
|
|
outer_unit:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- mm
|
|
- in
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Millimeters
|
|
- Inches
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- powerfeed_count
|
|
- site
|
|
- status
|
|
- url
|
|
RackGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site:
|
|
$ref: '#/components/schemas/NestedSite'
|
|
parent:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRackGroup'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- rack_count
|
|
- site
|
|
- url
|
|
RackReservation:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
rack:
|
|
$ref: '#/components/schemas/NestedRack'
|
|
units:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
user:
|
|
$ref: '#/components/schemas/NestedUser'
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- description
|
|
- display
|
|
- id
|
|
- rack
|
|
- units
|
|
- url
|
|
- user
|
|
RackRole:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- rack_count
|
|
- url
|
|
RackTypeChoices:
|
|
enum:
|
|
- 2-post-frame
|
|
- 4-post-frame
|
|
- 4-post-cabinet
|
|
- wall-frame
|
|
- wall-cabinet
|
|
type: string
|
|
RackUnit:
|
|
type: object
|
|
description: A rack unit is an abstraction formed by the set (rack, position,
|
|
face); it does not exist as a row in the database.
|
|
properties:
|
|
id:
|
|
type: integer
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
readOnly: true
|
|
face:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- front
|
|
- rear
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Front
|
|
- Rear
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
occupied:
|
|
type: boolean
|
|
readOnly: true
|
|
required:
|
|
- device
|
|
- face
|
|
- id
|
|
- name
|
|
- occupied
|
|
RearPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- 8p8c
|
|
- 8p6c
|
|
- 8p4c
|
|
- 8p2c
|
|
- gg45
|
|
- tera-4p
|
|
- tera-2p
|
|
- tera-1p
|
|
- 110-punch
|
|
- bnc
|
|
- mrj21
|
|
- fc
|
|
- lc
|
|
- lc-apc
|
|
- lsh
|
|
- lsh-apc
|
|
- mpo
|
|
- mtrj
|
|
- sc
|
|
- sc-apc
|
|
- st
|
|
- cs
|
|
- sn
|
|
- urm-p2
|
|
- urm-p4
|
|
- urm-p8
|
|
- splice
|
|
label:
|
|
type: string
|
|
enum:
|
|
- 8P8C
|
|
- 8P6C
|
|
- 8P4C
|
|
- 8P2C
|
|
- GG45
|
|
- TERA 4P
|
|
- TERA 2P
|
|
- TERA 1P
|
|
- 110 Punch
|
|
- BNC
|
|
- MRJ21
|
|
- FC
|
|
- LC
|
|
- LC/APC
|
|
- LSH
|
|
- LSH/APC
|
|
- MPO
|
|
- MTRJ
|
|
- SC
|
|
- SC/APC
|
|
- ST
|
|
- CS
|
|
- SN
|
|
- URM-P2
|
|
- URM-P4
|
|
- URM-P8
|
|
- Splice
|
|
positions:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
RearPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
$ref: '#/components/schemas/NestedDeviceType'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- 8p8c
|
|
- 8p6c
|
|
- 8p4c
|
|
- 8p2c
|
|
- gg45
|
|
- tera-4p
|
|
- tera-2p
|
|
- tera-1p
|
|
- 110-punch
|
|
- bnc
|
|
- mrj21
|
|
- fc
|
|
- lc
|
|
- lc-apc
|
|
- lsh
|
|
- lsh-apc
|
|
- mpo
|
|
- mtrj
|
|
- sc
|
|
- sc-apc
|
|
- st
|
|
- cs
|
|
- sn
|
|
- urm-p2
|
|
- urm-p4
|
|
- urm-p8
|
|
- splice
|
|
label:
|
|
type: string
|
|
enum:
|
|
- 8P8C
|
|
- 8P6C
|
|
- 8P4C
|
|
- 8P2C
|
|
- GG45
|
|
- TERA 4P
|
|
- TERA 2P
|
|
- TERA 1P
|
|
- 110 Punch
|
|
- BNC
|
|
- MRJ21
|
|
- FC
|
|
- LC
|
|
- LC/APC
|
|
- LSH
|
|
- LSH/APC
|
|
- MPO
|
|
- MTRJ
|
|
- SC
|
|
- SC/APC
|
|
- ST
|
|
- CS
|
|
- SN
|
|
- URM-P2
|
|
- URM-P4
|
|
- URM-P8
|
|
- Splice
|
|
positions:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
Region:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
parent:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRegion'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- site_count
|
|
- url
|
|
RegularExpressionValidationRule:
|
|
type: object
|
|
description: Serializer for `RegularExpressionValidationRule` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
content_type:
|
|
type: string
|
|
field:
|
|
type: string
|
|
maxLength: 50
|
|
regular_expression:
|
|
type: string
|
|
enabled:
|
|
type: boolean
|
|
error_message:
|
|
type: string
|
|
nullable: true
|
|
description: Optional error message to display when validation fails.
|
|
maxLength: 255
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_type
|
|
- created
|
|
- display
|
|
- field
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- regular_expression
|
|
- slug
|
|
- url
|
|
Relationship:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Internal relationship name
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/RelationshipTypeChoices'
|
|
description: Cardinality of this relationship
|
|
source_type:
|
|
type: string
|
|
source_label:
|
|
type: string
|
|
description: Label for related destination objects, as displayed on the
|
|
source object.
|
|
maxLength: 50
|
|
source_hidden:
|
|
type: boolean
|
|
title: Hide for source object
|
|
description: Hide this relationship on the source object.
|
|
source_filter:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable source objects of the
|
|
selected type
|
|
destination_type:
|
|
type: string
|
|
destination_label:
|
|
type: string
|
|
description: Label for related source objects, as displayed on the destination
|
|
object.
|
|
maxLength: 50
|
|
destination_hidden:
|
|
type: boolean
|
|
title: Hide for destination object
|
|
description: Hide this relationship on the destination object.
|
|
destination_filter:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable destination objects
|
|
of the selected type
|
|
required:
|
|
- destination_type
|
|
- id
|
|
- name
|
|
- source_type
|
|
- url
|
|
RelationshipAssociation:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
relationship:
|
|
$ref: '#/components/schemas/NestedRelationship'
|
|
source_type:
|
|
type: string
|
|
source_id:
|
|
type: string
|
|
format: uuid
|
|
destination_type:
|
|
type: string
|
|
destination_id:
|
|
type: string
|
|
format: uuid
|
|
required:
|
|
- destination_id
|
|
- destination_type
|
|
- id
|
|
- relationship
|
|
- source_id
|
|
- source_type
|
|
RelationshipTypeChoices:
|
|
enum:
|
|
- one-to-one
|
|
- symmetric-one-to-one
|
|
- one-to-many
|
|
- many-to-many
|
|
- symmetric-many-to-many
|
|
type: string
|
|
Role:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- url
|
|
- vlan_count
|
|
RoleEnum:
|
|
enum:
|
|
- loopback
|
|
- secondary
|
|
- anycast
|
|
- vip
|
|
- vrrp
|
|
- hsrp
|
|
- glbp
|
|
- carp
|
|
type: string
|
|
RouteTarget:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Route target value (formatted in accordance with RFC 4360)
|
|
maxLength: 21
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
ScheduledJob:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Short Description For This Task
|
|
maxLength: 200
|
|
user:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedUser'
|
|
readOnly: true
|
|
job_model:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedJob'
|
|
readOnly: true
|
|
task:
|
|
type: string
|
|
title: Task Name
|
|
description: 'The name of the Celery task that should be run. (Example:
|
|
"proj.tasks.import_contacts")'
|
|
maxLength: 200
|
|
interval:
|
|
$ref: '#/components/schemas/IntervalEnum'
|
|
queue:
|
|
type: string
|
|
nullable: true
|
|
title: Queue Override
|
|
description: Queue defined in CELERY_TASK_QUEUES. Leave None for default
|
|
queuing.
|
|
maxLength: 200
|
|
job_class:
|
|
type: string
|
|
description: Name of the fully qualified Nautobot Job class path
|
|
maxLength: 255
|
|
last_run_at:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
title: Most Recent Run
|
|
description: Datetime that the schedule last triggered the task to run.
|
|
Reset to None if enabled is set to False.
|
|
total_run_count:
|
|
type: integer
|
|
readOnly: true
|
|
description: Running count of how many times the schedule has triggered
|
|
the task
|
|
date_changed:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
title: Last Modified
|
|
description: Datetime that this scheduled job was last modified
|
|
description:
|
|
type: string
|
|
description: Detailed description about the details of this scheduled job
|
|
approved_by_user:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedUser'
|
|
readOnly: true
|
|
approval_required:
|
|
type: boolean
|
|
approved_at:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
title: Approval date/time
|
|
description: Datetime that the schedule was approved
|
|
required:
|
|
- approved_at
|
|
- approved_by_user
|
|
- date_changed
|
|
- id
|
|
- interval
|
|
- job_class
|
|
- job_model
|
|
- last_run_at
|
|
- name
|
|
- task
|
|
- total_run_count
|
|
- url
|
|
- user
|
|
Secret:
|
|
type: object
|
|
description: Serializer for `Secret` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
provider:
|
|
type: string
|
|
maxLength: 100
|
|
parameters:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- provider
|
|
- url
|
|
SecretTypeEnum:
|
|
enum:
|
|
- key
|
|
- password
|
|
- secret
|
|
- token
|
|
- username
|
|
type: string
|
|
SecretsGroup:
|
|
type: object
|
|
description: Serializer for `SecretsGroup` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
secrets:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedSecretsGroupAssociation'
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- secrets
|
|
- url
|
|
SecretsGroupAssociation:
|
|
type: object
|
|
description: Serializer for `SecretsGroupAssociation` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
group:
|
|
$ref: '#/components/schemas/NestedSecretsGroup'
|
|
access_type:
|
|
$ref: '#/components/schemas/AccessTypeEnum'
|
|
secret_type:
|
|
$ref: '#/components/schemas/SecretTypeEnum'
|
|
secret:
|
|
$ref: '#/components/schemas/NestedSecret'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- access_type
|
|
- display
|
|
- group
|
|
- id
|
|
- secret
|
|
- secret_type
|
|
- url
|
|
Service:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
nullable: true
|
|
virtual_machine:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVirtualMachine'
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
ports:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 1
|
|
protocol:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- tcp
|
|
- udp
|
|
label:
|
|
type: string
|
|
enum:
|
|
- TCP
|
|
- UDP
|
|
ipaddresses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
type: integer
|
|
readOnly: true
|
|
address:
|
|
type: string
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- address
|
|
- display
|
|
- family
|
|
- id
|
|
- url
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- ports
|
|
- url
|
|
Site:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- planned
|
|
- retired
|
|
- staging
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Decommissioning
|
|
- Planned
|
|
- Retired
|
|
- Staging
|
|
region:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRegion'
|
|
nullable: true
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
facility:
|
|
type: string
|
|
description: Local facility ID or description
|
|
maxLength: 50
|
|
asn:
|
|
type: integer
|
|
maximum: 4294967295
|
|
minimum: 1
|
|
format: int64
|
|
nullable: true
|
|
description: 32-bit autonomous system number
|
|
time_zone:
|
|
type: string
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
physical_address:
|
|
type: string
|
|
maxLength: 200
|
|
shipping_address:
|
|
type: string
|
|
maxLength: 200
|
|
latitude:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,2}(?:\.\d{0,6})?$
|
|
nullable: true
|
|
description: GPS coordinate (latitude)
|
|
longitude:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,3}(?:\.\d{0,6})?$
|
|
nullable: true
|
|
description: GPS coordinate (longitude)
|
|
contact_name:
|
|
type: string
|
|
maxLength: 50
|
|
contact_phone:
|
|
type: string
|
|
maxLength: 20
|
|
contact_email:
|
|
type: string
|
|
format: email
|
|
title: Contact E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- rack_count
|
|
- status
|
|
- url
|
|
- virtualmachine_count
|
|
- vlan_count
|
|
SoftwareImageLCM:
|
|
type: object
|
|
description: REST API serializer for SoftwareImageLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
image_file_name:
|
|
type: string
|
|
maxLength: 100
|
|
software:
|
|
$ref: '#/components/schemas/NestedSoftwareLCM'
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
download_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
image_file_checksum:
|
|
type: string
|
|
maxLength: 256
|
|
default_image:
|
|
type: boolean
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- image_file_name
|
|
- software
|
|
- url
|
|
SoftwareLCM:
|
|
type: object
|
|
description: REST API serializer for SoftwareLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_platform:
|
|
$ref: '#/components/schemas/NestedPlatform'
|
|
version:
|
|
type: string
|
|
maxLength: 50
|
|
alias:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 50
|
|
release_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Support
|
|
documentation_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
software_images:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
image_file_name:
|
|
type: string
|
|
maxLength: 100
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
download_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
image_file_checksum:
|
|
type: string
|
|
maxLength: 256
|
|
default_image:
|
|
type: boolean
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- image_file_name
|
|
- url
|
|
long_term_support:
|
|
type: boolean
|
|
pre_release:
|
|
type: boolean
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_platform
|
|
- display
|
|
- id
|
|
- url
|
|
- version
|
|
Status:
|
|
type: object
|
|
description: Serializer for `Status` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
name:
|
|
type: string
|
|
maxLength: 50
|
|
slug:
|
|
type: string
|
|
maxLength: 50
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_types
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
Status4f5Enum:
|
|
type: string
|
|
enum: []
|
|
SubdeviceRoleEnum:
|
|
enum:
|
|
- parent
|
|
- child
|
|
type: string
|
|
SupplyEnum:
|
|
enum:
|
|
- ac
|
|
- dc
|
|
type: string
|
|
TagSerializerField:
|
|
type: object
|
|
description: NestedSerializer field for `Tag` object fields.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- slug
|
|
- url
|
|
TagSerializerVersion13:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tagged_items:
|
|
type: integer
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_types
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- slug
|
|
- tagged_items
|
|
- url
|
|
Tenant:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
group:
|
|
$ref: '#/components/schemas/NestedTenantGroup'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
ipaddress_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
vrf_count:
|
|
type: integer
|
|
readOnly: true
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- cluster_count
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- ipaddress_count
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- rack_count
|
|
- site_count
|
|
- url
|
|
- virtualmachine_count
|
|
- vlan_count
|
|
- vrf_count
|
|
TenantGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
parent:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenantGroup'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tenant_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- tenant_count
|
|
- url
|
|
TermSideEnum:
|
|
enum:
|
|
- A
|
|
- Z
|
|
type: string
|
|
Token:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
expires:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
key:
|
|
type: string
|
|
maxLength: 40
|
|
minLength: 40
|
|
write_enabled:
|
|
type: boolean
|
|
description: Permit create/update/delete operations using this key
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- url
|
|
User:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
username:
|
|
type: string
|
|
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
|
|
only.
|
|
pattern: ^[\w.@+-]+$
|
|
maxLength: 150
|
|
password:
|
|
type: string
|
|
writeOnly: true
|
|
maxLength: 128
|
|
first_name:
|
|
type: string
|
|
maxLength: 150
|
|
last_name:
|
|
type: string
|
|
maxLength: 150
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: Email address
|
|
maxLength: 254
|
|
is_staff:
|
|
type: boolean
|
|
title: Staff status
|
|
description: Designates whether the user can log into this admin site.
|
|
is_active:
|
|
type: boolean
|
|
title: Active
|
|
description: Designates whether this user should be treated as active. Unselect
|
|
this instead of deleting accounts.
|
|
date_joined:
|
|
type: string
|
|
format: date-time
|
|
groups:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 150
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- password
|
|
- url
|
|
- username
|
|
VLAN:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
nullable: true
|
|
group:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVLANGroup'
|
|
nullable: true
|
|
vid:
|
|
type: integer
|
|
maximum: 4094
|
|
minimum: 1
|
|
title: ID
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- deprecated
|
|
- reserved
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Deprecated
|
|
- Reserved
|
|
role:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedRole'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- status
|
|
- url
|
|
- vid
|
|
VLANGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
- vlan_count
|
|
VMInterface:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
virtual_machine:
|
|
$ref: '#/components/schemas/NestedVirtualMachine'
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
enabled:
|
|
type: boolean
|
|
mtu:
|
|
type: integer
|
|
maximum: 65536
|
|
minimum: 1
|
|
nullable: true
|
|
mac_address:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 18
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
mode:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- access
|
|
- tagged
|
|
- tagged-all
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Access
|
|
- Tagged
|
|
- Tagged (All)
|
|
untagged_vlan:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedVLAN'
|
|
nullable: true
|
|
tagged_vlans:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
vid:
|
|
type: integer
|
|
maximum: 4094
|
|
minimum: 1
|
|
title: ID
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- vid
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtual_machine
|
|
VRF:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
rd:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Unique route distinguisher (as defined in RFC 4364)
|
|
maxLength: 21
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
enforce_unique:
|
|
type: boolean
|
|
title: Enforce unique space
|
|
description: Prevent duplicate prefixes/IP addresses within this VRF
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
import_targets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Route target value (formatted in accordance with RFC
|
|
4360)
|
|
maxLength: 21
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
export_targets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Route target value (formatted in accordance with RFC
|
|
4360)
|
|
maxLength: 21
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
ipaddress_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- display
|
|
- id
|
|
- ipaddress_count
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- url
|
|
ValidatedSoftwareLCM:
|
|
type: object
|
|
description: REST API serializer for ValidatedSoftwareLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
software:
|
|
$ref: '#/components/schemas/NestedSoftwareLCM'
|
|
devices:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_roles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
start:
|
|
type: string
|
|
format: date
|
|
title: Valid Since
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Valid Until
|
|
preferred:
|
|
type: boolean
|
|
title: Preferred Version
|
|
valid:
|
|
type: string
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- software
|
|
- start
|
|
- url
|
|
- valid
|
|
VirtualChassis:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
domain:
|
|
type: string
|
|
maxLength: 30
|
|
master:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
member_count:
|
|
type: integer
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- member_count
|
|
- name
|
|
- url
|
|
VirtualMachineWithConfigContext:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- failed
|
|
- offline
|
|
- planned
|
|
- staged
|
|
label:
|
|
type: string
|
|
enum:
|
|
- Active
|
|
- Decommissioning
|
|
- Failed
|
|
- Offline
|
|
- Planned
|
|
- Staged
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
readOnly: true
|
|
cluster:
|
|
$ref: '#/components/schemas/NestedCluster'
|
|
role:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDeviceRole'
|
|
nullable: true
|
|
tenant:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedTenant'
|
|
nullable: true
|
|
platform:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedPlatform'
|
|
nullable: true
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
primary_ip6:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
nullable: true
|
|
vcpus:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
memory:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Memory (MB)
|
|
disk:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Disk (GB)
|
|
comments:
|
|
type: string
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
local_context_schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedConfigContextSchema'
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
config_context:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster
|
|
- config_context
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- primary_ip
|
|
- site
|
|
- status
|
|
- url
|
|
VulnerabilityLCM:
|
|
type: object
|
|
description: REST API serializer for VulnerabilityLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
cve:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCVELCM'
|
|
readOnly: true
|
|
software:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSoftwareLCM'
|
|
readOnly: true
|
|
device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
inventory_item:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedInventoryItem'
|
|
readOnly: true
|
|
status:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
enum: []
|
|
label:
|
|
type: string
|
|
enum: []
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
required:
|
|
- cve
|
|
- device
|
|
- display
|
|
- id
|
|
- inventory_item
|
|
- software
|
|
- status
|
|
- url
|
|
Webhook:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
name:
|
|
type: string
|
|
maxLength: 150
|
|
type_create:
|
|
type: boolean
|
|
description: Call this webhook when a matching object is created.
|
|
type_update:
|
|
type: boolean
|
|
description: Call this webhook when a matching object is updated.
|
|
type_delete:
|
|
type: boolean
|
|
description: Call this webhook when a matching object is deleted.
|
|
payload_url:
|
|
type: string
|
|
title: URL
|
|
description: A POST will be sent to this URL when the webhook is called.
|
|
maxLength: 500
|
|
http_method:
|
|
$ref: '#/components/schemas/HttpMethodEnum'
|
|
http_content_type:
|
|
type: string
|
|
description: The complete list of official content types is available <a
|
|
href="https://www.iana.org/assignments/media-types/media-types.xhtml">here</a>.
|
|
maxLength: 100
|
|
additional_headers:
|
|
type: string
|
|
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 support with the
|
|
same context as the request body (below).'
|
|
body_template:
|
|
type: string
|
|
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>.'
|
|
secret:
|
|
type: string
|
|
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.
|
|
maxLength: 255
|
|
ssl_verification:
|
|
type: boolean
|
|
description: Enable SSL certificate verification. Disable with caution!
|
|
ca_file_path:
|
|
type: string
|
|
nullable: true
|
|
description: The specific CA certificate file to use for SSL verification.
|
|
Leave blank to use the system defaults.
|
|
maxLength: 4096
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_types
|
|
- display
|
|
- id
|
|
- name
|
|
- payload_url
|
|
- url
|
|
WidthEnum:
|
|
enum:
|
|
- 10
|
|
- 19
|
|
- 21
|
|
- 23
|
|
type: integer
|
|
WritableAggregate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FamilyEnum'
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
rir:
|
|
type: string
|
|
format: uuid
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
date_added:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- family
|
|
- id
|
|
- last_updated
|
|
- prefix
|
|
- rir
|
|
- url
|
|
WritableCable:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
termination_a_type:
|
|
type: string
|
|
termination_a_id:
|
|
type: string
|
|
format: uuid
|
|
termination_a:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
termination_b_type:
|
|
type: string
|
|
termination_b_id:
|
|
type: string
|
|
format: uuid
|
|
termination_b:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CableTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
status:
|
|
$ref: '#/components/schemas/WritableCableStatusEnum'
|
|
label:
|
|
type: string
|
|
maxLength: 100
|
|
color:
|
|
type: string
|
|
pattern: ^[0-9a-f]{6}$
|
|
maxLength: 6
|
|
length:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
length_unit:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LengthUnitEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- display
|
|
- id
|
|
- status
|
|
- termination_a
|
|
- termination_a_id
|
|
- termination_a_type
|
|
- termination_b
|
|
- termination_b_id
|
|
- termination_b_type
|
|
- url
|
|
WritableCableStatusEnum:
|
|
type: string
|
|
enum:
|
|
- connected
|
|
- decommissioning
|
|
- planned
|
|
WritableCircuit:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
cid:
|
|
type: string
|
|
title: Circuit ID
|
|
maxLength: 100
|
|
provider:
|
|
type: string
|
|
format: uuid
|
|
type:
|
|
type: string
|
|
format: uuid
|
|
status:
|
|
$ref: '#/components/schemas/WritableCircuitStatusEnum'
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
install_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Date installed
|
|
commit_rate:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Commit rate (Kbps)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
termination_a:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CircuitCircuitTermination'
|
|
readOnly: true
|
|
termination_z:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CircuitCircuitTermination'
|
|
readOnly: true
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cid
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- provider
|
|
- status
|
|
- termination_a
|
|
- termination_z
|
|
- type
|
|
- url
|
|
WritableCircuitStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioned
|
|
- deprovisioning
|
|
- offline
|
|
- planned
|
|
- provisioning
|
|
WritableCircuitTermination:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
circuit:
|
|
type: string
|
|
format: uuid
|
|
term_side:
|
|
allOf:
|
|
- $ref: '#/components/schemas/TermSideEnum'
|
|
title: Termination
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
provider_network:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
port_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Port speed (Kbps)
|
|
upstream_speed:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Upstream speed (Kbps)
|
|
description: Upstream speed, if different from port speed
|
|
xconnect_id:
|
|
type: string
|
|
title: Cross-connect ID
|
|
maxLength: 50
|
|
pp_info:
|
|
type: string
|
|
title: Patch panel/port(s)
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- circuit
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- display
|
|
- id
|
|
- term_side
|
|
- url
|
|
WritableCluster:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
type:
|
|
type: string
|
|
format: uuid
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- type
|
|
- url
|
|
- virtualmachine_count
|
|
WritableConfigContext:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
owner_content_type:
|
|
type: string
|
|
nullable: true
|
|
owner_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optional schema to validate the structure of the data
|
|
is_active:
|
|
type: boolean
|
|
regions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
sites:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
roles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
platforms:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
cluster_groups:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
clusters:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tenant_groups:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tenants:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
data:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- created
|
|
- data
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- owner
|
|
- url
|
|
WritableConsolePort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableConsolePortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableConsoleServerPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableConsoleServerPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ConsolePortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableContactLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 80
|
|
address:
|
|
type: string
|
|
maxLength: 200
|
|
phone:
|
|
type: string
|
|
maxLength: 20
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: Contact E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
priority:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
contract:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- contract
|
|
- display
|
|
- name
|
|
WritableContractLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
provider:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Vendor
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
start:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract Start Date
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Contract End Date
|
|
cost:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
|
|
nullable: true
|
|
title: Contract Cost
|
|
support_level:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
contract_type:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 32
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- expired
|
|
- id
|
|
- name
|
|
WritableCustomField:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
content_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
type:
|
|
allOf:
|
|
- $ref: '#/components/schemas/CustomFieldTypeChoices'
|
|
description: The type of value(s) allowed for this field.
|
|
name:
|
|
type: string
|
|
title: Slug
|
|
description: URL-friendly unique shorthand.
|
|
maxLength: 50
|
|
label:
|
|
type: string
|
|
description: Name of the field as displayed to users (if not provided, the
|
|
field's slug will be used.)
|
|
maxLength: 50
|
|
description:
|
|
type: string
|
|
description: A helpful description for this field.
|
|
maxLength: 200
|
|
required:
|
|
type: boolean
|
|
description: If true, this field is required when creating new objects or
|
|
editing an existing object.
|
|
filter_logic:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FilterLogicEnum'
|
|
description: Loose matches any instance of a given string; Exact matches
|
|
the entire field.
|
|
default:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Default value for the field (must be a JSON value). Encapsulate
|
|
strings with double quotes (e.g. "Foo").
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description: Fields with higher weights appear lower in a form.
|
|
validation_minimum:
|
|
type: integer
|
|
maximum: 9223372036854775807
|
|
minimum: -9223372036854775808
|
|
format: int64
|
|
nullable: true
|
|
title: Minimum value
|
|
description: Minimum allowed value (for numeric fields).
|
|
validation_maximum:
|
|
type: integer
|
|
maximum: 9223372036854775807
|
|
minimum: -9223372036854775808
|
|
format: int64
|
|
nullable: true
|
|
title: Maximum value
|
|
description: Maximum allowed value (for numeric fields).
|
|
validation_regex:
|
|
type: string
|
|
description: Regular expression to enforce on text field values. Use ^ and
|
|
$ to force matching of entire string. For example, <code>^[A-Z]{3}$</code>
|
|
will limit values to exactly three uppercase letters. Regular expression
|
|
on select and multi-select will be applied at <code>Custom Field Choices</code>
|
|
definition.
|
|
maxLength: 500
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- content_types
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableCustomFieldChoice:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
field:
|
|
type: string
|
|
format: uuid
|
|
value:
|
|
type: string
|
|
maxLength: 100
|
|
weight:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
description: Higher weights appear later in the list
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- field
|
|
- id
|
|
- url
|
|
- value
|
|
WritableDeviceBay:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
installed_device:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableDeviceBayTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableDeviceType:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
manufacturer:
|
|
type: string
|
|
format: uuid
|
|
model:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
part_number:
|
|
type: string
|
|
description: Discrete part number (optional)
|
|
maxLength: 50
|
|
u_height:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
title: Height (U)
|
|
is_full_depth:
|
|
type: boolean
|
|
description: Device consumes both front and rear rack faces
|
|
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.
|
|
oneOf:
|
|
- $ref: '#/components/schemas/SubdeviceRoleEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
front_image:
|
|
type: string
|
|
format: uri
|
|
rear_image:
|
|
type: string
|
|
format: uri
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- manufacturer
|
|
- model
|
|
- url
|
|
WritableDeviceWithConfigContext:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 64
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
device_role:
|
|
type: string
|
|
format: uuid
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this device
|
|
maxLength: 50
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
rack:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
position:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
title: Position (U)
|
|
description: The lowest-numbered unit occupied by the device
|
|
face:
|
|
title: Rack face
|
|
oneOf:
|
|
- $ref: '#/components/schemas/FaceEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
parent_device:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableDeviceWithConfigContextStatusEnum'
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv4
|
|
primary_ip6:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv6
|
|
secrets_group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
cluster:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
virtual_chassis:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vc_position:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
vc_priority:
|
|
type: integer
|
|
maximum: 255
|
|
minimum: 0
|
|
nullable: true
|
|
comments:
|
|
type: string
|
|
local_context_schema:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optional schema to validate the structure of the data
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
config_context:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- config_context
|
|
- created
|
|
- device_role
|
|
- device_type
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- parent_device
|
|
- primary_ip
|
|
- site
|
|
- status
|
|
- url
|
|
WritableDeviceWithConfigContextStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- failed
|
|
- inventory
|
|
- offline
|
|
- planned
|
|
- staged
|
|
WritableFrontPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
rear_port:
|
|
type: string
|
|
format: uuid
|
|
rear_port_position:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
default: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- rear_port
|
|
- type
|
|
- url
|
|
WritableFrontPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
rear_port:
|
|
type: string
|
|
format: uuid
|
|
rear_port_position:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
default: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- rear_port
|
|
- type
|
|
- url
|
|
WritableGitRepository:
|
|
type: object
|
|
description: Git repositories defined as a data source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
remote_url:
|
|
type: string
|
|
format: uri
|
|
description: Only HTTP and HTTPS URLs are presently supported
|
|
maxLength: 255
|
|
branch:
|
|
type: string
|
|
maxLength: 64
|
|
token:
|
|
type: string
|
|
writeOnly: true
|
|
username:
|
|
type: string
|
|
maxLength: 64
|
|
secrets_group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
current_head:
|
|
type: string
|
|
description: Commit hash of the most recent fetch from the selected branch.
|
|
Used for syncing between workers.
|
|
maxLength: 48
|
|
provided_contents:
|
|
type: array
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ProvidedContentsEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- remote_url
|
|
- url
|
|
WritableHardwareLCM:
|
|
type: object
|
|
description: API serializer.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
expired:
|
|
type: string
|
|
readOnly: true
|
|
devices:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedDevice'
|
|
readOnly: true
|
|
description: Devices tied to Device Type
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
inventory_item:
|
|
type: string
|
|
nullable: true
|
|
title: Inventory Item Part
|
|
maxLength: 255
|
|
release_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_sale:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_sw_releases:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Releases
|
|
end_of_security_patches:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
documentation_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- devices
|
|
- display
|
|
- expired
|
|
- id
|
|
WritableIPAddress:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FamilyEnum'
|
|
readOnly: true
|
|
address:
|
|
type: string
|
|
vrf:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableIPAddressStatusEnum'
|
|
role:
|
|
description: The functional role of this IP
|
|
oneOf:
|
|
- $ref: '#/components/schemas/RoleEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
assigned_object_type:
|
|
type: string
|
|
nullable: true
|
|
assigned_object_id:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
assigned_object:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
nat_inside:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: NAT (Inside)
|
|
description: The IP Addresses for which this address is the "outside" IP
|
|
nat_outside:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
dns_name:
|
|
type: string
|
|
description: Hostname or FQDN (not case-sensitive)
|
|
pattern: ^[0-9A-Za-z._-]+$
|
|
maxLength: 255
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- address
|
|
- assigned_object
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- family
|
|
- id
|
|
- last_updated
|
|
- nat_outside
|
|
- status
|
|
- url
|
|
WritableIPAddressStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- deprecated
|
|
- dhcp
|
|
- reserved
|
|
- slaac
|
|
WritableInterface:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/InterfaceTypeChoices'
|
|
enabled:
|
|
type: boolean
|
|
lag:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Parent LAG
|
|
mtu:
|
|
type: integer
|
|
maximum: 65536
|
|
minimum: 1
|
|
nullable: true
|
|
mac_address:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 18
|
|
mgmt_only:
|
|
type: boolean
|
|
title: Management only
|
|
description: This interface is used only for out-of-band management
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
mode:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ModeEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
untagged_vlan:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tagged_vlans:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
title: Tagged VLANs
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
count_ipaddresses:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- count_ipaddresses
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
WritableInterfaceTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/InterfaceTypeChoices'
|
|
mgmt_only:
|
|
type: boolean
|
|
title: Management only
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
WritableInventoryItem:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
manufacturer:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
part_id:
|
|
type: string
|
|
description: Manufacturer-assigned part identifier
|
|
maxLength: 50
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this item
|
|
maxLength: 50
|
|
discovered:
|
|
type: boolean
|
|
description: This item was automatically discovered
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- computed_fields
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritableObjectPermission:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
enabled:
|
|
type: boolean
|
|
object_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
groups:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
users:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
actions:
|
|
type: object
|
|
additionalProperties: {}
|
|
description: The list of actions granted by this permission
|
|
constraints:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
description: Queryset filter matching the applicable objects of the selected
|
|
type(s)
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- actions
|
|
- display
|
|
- id
|
|
- name
|
|
- object_types
|
|
- url
|
|
WritablePlatform:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
manufacturer:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optionally limit this platform to devices of a certain manufacturer
|
|
napalm_driver:
|
|
type: string
|
|
description: The name of the NAPALM driver to use when interacting with
|
|
devices
|
|
maxLength: 50
|
|
napalm_args:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
title: NAPALM arguments
|
|
description: Additional arguments to pass when initiating the NAPALM driver
|
|
(JSON format)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
- virtualmachine_count
|
|
WritablePowerFeed:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
power_panel:
|
|
type: string
|
|
format: uuid
|
|
rack:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
status:
|
|
$ref: '#/components/schemas/WritablePowerFeedStatusEnum'
|
|
type:
|
|
$ref: '#/components/schemas/PowerFeedTypeChoices'
|
|
supply:
|
|
$ref: '#/components/schemas/SupplyEnum'
|
|
phase:
|
|
$ref: '#/components/schemas/PhaseEnum'
|
|
voltage:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: -32768
|
|
amperage:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
max_utilization:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
description: Maximum permissible draw (percentage)
|
|
comments:
|
|
type: string
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- power_panel
|
|
- status
|
|
- url
|
|
WritablePowerFeedStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- failed
|
|
- offline
|
|
- planned
|
|
WritablePowerOutlet:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerOutletTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
power_port:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
feed_leg:
|
|
description: Phase (for three-phase feeds)
|
|
oneOf:
|
|
- $ref: '#/components/schemas/FeedLegEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritablePowerOutletTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerOutletTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
power_port:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
feed_leg:
|
|
description: Phase (for three-phase feeds)
|
|
oneOf:
|
|
- $ref: '#/components/schemas/FeedLegEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritablePowerPanel:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
rack_group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- display
|
|
- id
|
|
- name
|
|
- powerfeed_count
|
|
- site
|
|
- url
|
|
WritablePowerPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
description: Physical port type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerPortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
maximum_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Maximum power draw (watts)
|
|
allocated_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Allocated power draw (watts)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
connected_endpoint_reachable:
|
|
type: boolean
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- connected_endpoint
|
|
- connected_endpoint_reachable
|
|
- connected_endpoint_type
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritablePowerPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/PowerPortTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
maximum_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Maximum power draw (watts)
|
|
allocated_draw:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 1
|
|
nullable: true
|
|
description: Allocated power draw (watts)
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
WritablePrefix:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
family:
|
|
allOf:
|
|
- $ref: '#/components/schemas/FamilyEnum'
|
|
readOnly: true
|
|
prefix:
|
|
type: string
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vrf:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vlan:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritablePrefixStatusEnum'
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: The primary function of this prefix
|
|
is_pool:
|
|
type: boolean
|
|
title: Is a pool
|
|
description: All IP addresses within this prefix are considered usable
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- family
|
|
- id
|
|
- last_updated
|
|
- prefix
|
|
- status
|
|
- url
|
|
WritablePrefixStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- container
|
|
- deprecated
|
|
- p2p
|
|
- reserved
|
|
WritableProviderNetwork:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
provider:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- provider
|
|
- url
|
|
WritableRack:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
facility_id:
|
|
type: string
|
|
nullable: true
|
|
description: Locally-assigned identifier
|
|
maxLength: 50
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Assigned group
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableRackStatusEnum'
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Functional role
|
|
serial:
|
|
type: string
|
|
title: Serial number
|
|
maxLength: 255
|
|
asset_tag:
|
|
type: string
|
|
nullable: true
|
|
description: A unique tag used to identify this rack
|
|
maxLength: 50
|
|
type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/RackTypeChoices'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
width:
|
|
allOf:
|
|
- $ref: '#/components/schemas/WidthEnum'
|
|
description: Rail-to-rail width
|
|
minimum: 0
|
|
maximum: 32767
|
|
u_height:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
title: Height (U)
|
|
description: Height in rack units
|
|
desc_units:
|
|
type: boolean
|
|
title: Descending units
|
|
description: Units are numbered top-to-bottom
|
|
outer_width:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
description: Outer dimension of rack (width)
|
|
outer_depth:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
description: Outer dimension of rack (depth)
|
|
outer_unit:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OuterUnitEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
powerfeed_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- powerfeed_count
|
|
- site
|
|
- status
|
|
- url
|
|
WritableRackGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- rack_count
|
|
- site
|
|
- url
|
|
WritableRackReservation:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
rack:
|
|
type: string
|
|
format: uuid
|
|
units:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
user:
|
|
type: string
|
|
format: uuid
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- description
|
|
- display
|
|
- id
|
|
- rack
|
|
- units
|
|
- url
|
|
- user
|
|
WritableRackStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- available
|
|
- deprecated
|
|
- planned
|
|
- reserved
|
|
WritableRearPort:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
positions:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
cable:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedCable'
|
|
readOnly: true
|
|
cable_peer:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
readOnly: true
|
|
cable_peer_type:
|
|
type: string
|
|
nullable: true
|
|
readOnly: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cable
|
|
- cable_peer
|
|
- cable_peer_type
|
|
- computed_fields
|
|
- device
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
WritableRearPortTemplate:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_type:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
label:
|
|
type: string
|
|
description: Physical label
|
|
maxLength: 64
|
|
type:
|
|
$ref: '#/components/schemas/PortTypeChoices'
|
|
positions:
|
|
type: integer
|
|
maximum: 1024
|
|
minimum: 1
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_type
|
|
- display
|
|
- id
|
|
- name
|
|
- type
|
|
- url
|
|
WritableRegion:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- site_count
|
|
- url
|
|
WritableRelationshipAssociation:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
relationship:
|
|
type: string
|
|
format: uuid
|
|
source_type:
|
|
type: string
|
|
source_id:
|
|
type: string
|
|
format: uuid
|
|
destination_type:
|
|
type: string
|
|
destination_id:
|
|
type: string
|
|
format: uuid
|
|
required:
|
|
- destination_id
|
|
- destination_type
|
|
- id
|
|
- relationship
|
|
- source_id
|
|
- source_type
|
|
WritableRouteTarget:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Route target value (formatted in accordance with RFC 4360)
|
|
maxLength: 21
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
WritableSecretsGroupAssociation:
|
|
type: object
|
|
description: Serializer for `SecretsGroupAssociation` objects.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
access_type:
|
|
$ref: '#/components/schemas/AccessTypeEnum'
|
|
secret_type:
|
|
$ref: '#/components/schemas/SecretTypeEnum'
|
|
secret:
|
|
type: string
|
|
format: uuid
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- access_type
|
|
- display
|
|
- group
|
|
- id
|
|
- secret
|
|
- secret_type
|
|
- url
|
|
WritableService:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
virtual_machine:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
ports:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 1
|
|
protocol:
|
|
$ref: '#/components/schemas/ProtocolEnum'
|
|
ipaddresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
title: IP addresses
|
|
title: IP addresses
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- ports
|
|
- protocol
|
|
- url
|
|
WritableSite:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
status:
|
|
$ref: '#/components/schemas/WritableSiteStatusEnum'
|
|
region:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
facility:
|
|
type: string
|
|
description: Local facility ID or description
|
|
maxLength: 50
|
|
asn:
|
|
type: integer
|
|
maximum: 4294967295
|
|
minimum: 1
|
|
format: int64
|
|
nullable: true
|
|
description: 32-bit autonomous system number
|
|
time_zone:
|
|
type: string
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
physical_address:
|
|
type: string
|
|
maxLength: 200
|
|
shipping_address:
|
|
type: string
|
|
maxLength: 200
|
|
latitude:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,2}(?:\.\d{0,6})?$
|
|
nullable: true
|
|
description: GPS coordinate (latitude)
|
|
longitude:
|
|
type: string
|
|
format: decimal
|
|
pattern: ^-?\d{0,3}(?:\.\d{0,6})?$
|
|
nullable: true
|
|
description: GPS coordinate (longitude)
|
|
contact_name:
|
|
type: string
|
|
maxLength: 50
|
|
contact_phone:
|
|
type: string
|
|
maxLength: 20
|
|
contact_email:
|
|
type: string
|
|
format: email
|
|
title: Contact E-mail
|
|
maxLength: 254
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- computed_fields
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- rack_count
|
|
- status
|
|
- url
|
|
- virtualmachine_count
|
|
- vlan_count
|
|
WritableSiteStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- planned
|
|
- retired
|
|
- staging
|
|
WritableSoftwareImageLCM:
|
|
type: object
|
|
description: REST API serializer for SoftwareImageLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
image_file_name:
|
|
type: string
|
|
maxLength: 100
|
|
software:
|
|
type: string
|
|
format: uuid
|
|
title: Software Version
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
download_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
image_file_checksum:
|
|
type: string
|
|
maxLength: 256
|
|
default_image:
|
|
type: boolean
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- image_file_name
|
|
- software
|
|
- url
|
|
WritableSoftwareLCM:
|
|
type: object
|
|
description: REST API serializer for SoftwareLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
device_platform:
|
|
type: string
|
|
format: uuid
|
|
version:
|
|
type: string
|
|
maxLength: 50
|
|
alias:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 50
|
|
release_date:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
end_of_support:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: End of Software Support
|
|
documentation_url:
|
|
type: string
|
|
format: uri
|
|
maxLength: 200
|
|
software_images:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
long_term_support:
|
|
type: boolean
|
|
pre_release:
|
|
type: boolean
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- device_platform
|
|
- display
|
|
- id
|
|
- software_images
|
|
- url
|
|
- version
|
|
WritableTenant:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
comments:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
circuit_count:
|
|
type: integer
|
|
readOnly: true
|
|
device_count:
|
|
type: integer
|
|
readOnly: true
|
|
ipaddress_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
rack_count:
|
|
type: integer
|
|
readOnly: true
|
|
site_count:
|
|
type: integer
|
|
readOnly: true
|
|
virtualmachine_count:
|
|
type: integer
|
|
readOnly: true
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
vrf_count:
|
|
type: integer
|
|
readOnly: true
|
|
cluster_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- circuit_count
|
|
- cluster_count
|
|
- computed_fields
|
|
- created
|
|
- device_count
|
|
- display
|
|
- id
|
|
- ipaddress_count
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- rack_count
|
|
- site_count
|
|
- url
|
|
- virtualmachine_count
|
|
- vlan_count
|
|
- vrf_count
|
|
WritableTenantGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
parent:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tenant_count:
|
|
type: integer
|
|
readOnly: true
|
|
_depth:
|
|
type: integer
|
|
readOnly: true
|
|
title: ' depth'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- _depth
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- tenant_count
|
|
- url
|
|
WritableUser:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
username:
|
|
type: string
|
|
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
|
|
only.
|
|
pattern: ^[\w.@+-]+$
|
|
maxLength: 150
|
|
password:
|
|
type: string
|
|
writeOnly: true
|
|
maxLength: 128
|
|
first_name:
|
|
type: string
|
|
maxLength: 150
|
|
last_name:
|
|
type: string
|
|
maxLength: 150
|
|
email:
|
|
type: string
|
|
format: email
|
|
title: Email address
|
|
maxLength: 254
|
|
is_staff:
|
|
type: boolean
|
|
title: Staff status
|
|
description: Designates whether the user can log into this admin site.
|
|
is_active:
|
|
type: boolean
|
|
title: Active
|
|
description: Designates whether this user should be treated as active. Unselect
|
|
this instead of deleting accounts.
|
|
date_joined:
|
|
type: string
|
|
format: date-time
|
|
groups:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: The groups this user belongs to. A user will get all permissions
|
|
granted to each of their groups.
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- password
|
|
- url
|
|
- username
|
|
WritableVLAN:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
group:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
vid:
|
|
type: integer
|
|
maximum: 4094
|
|
minimum: 1
|
|
title: ID
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
status:
|
|
$ref: '#/components/schemas/WritableVLANStatusEnum'
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- status
|
|
- url
|
|
- vid
|
|
WritableVLANGroup:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
slug:
|
|
type: string
|
|
maxLength: 100
|
|
pattern: ^[-a-zA-Z0-9_]+$
|
|
site:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
vlan_count:
|
|
type: integer
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- url
|
|
- vlan_count
|
|
WritableVLANStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- deprecated
|
|
- reserved
|
|
WritableVMInterface:
|
|
type: object
|
|
description: |-
|
|
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
|
|
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
virtual_machine:
|
|
type: string
|
|
format: uuid
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
enabled:
|
|
type: boolean
|
|
mtu:
|
|
type: integer
|
|
maximum: 65536
|
|
minimum: 1
|
|
nullable: true
|
|
mac_address:
|
|
type: string
|
|
nullable: true
|
|
maxLength: 18
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
mode:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ModeEnum'
|
|
- $ref: '#/components/schemas/BlankEnum'
|
|
untagged_vlan:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tagged_vlans:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
title: Tagged VLANs
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- name
|
|
- url
|
|
- virtual_machine
|
|
WritableVRF:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 100
|
|
rd:
|
|
type: string
|
|
nullable: true
|
|
title: Route distinguisher
|
|
description: Unique route distinguisher (as defined in RFC 4364)
|
|
maxLength: 21
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
enforce_unique:
|
|
type: boolean
|
|
title: Enforce unique space
|
|
description: Prevent duplicate prefixes/IP addresses within this VRF
|
|
description:
|
|
type: string
|
|
maxLength: 200
|
|
import_targets:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
export_targets:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
ipaddress_count:
|
|
type: integer
|
|
readOnly: true
|
|
prefix_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- created
|
|
- display
|
|
- id
|
|
- ipaddress_count
|
|
- last_updated
|
|
- name
|
|
- prefix_count
|
|
- url
|
|
WritableValidatedSoftwareLCM:
|
|
type: object
|
|
description: REST API serializer for ValidatedSoftwareLCM records.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
software:
|
|
type: string
|
|
format: uuid
|
|
title: Software Version
|
|
devices:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
device_roles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
inventory_items:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
object_tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
start:
|
|
type: string
|
|
format: date
|
|
title: Valid Since
|
|
end:
|
|
type: string
|
|
format: date
|
|
nullable: true
|
|
title: Valid Until
|
|
preferred:
|
|
type: boolean
|
|
title: Preferred Version
|
|
valid:
|
|
type: string
|
|
readOnly: true
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- display
|
|
- id
|
|
- software
|
|
- start
|
|
- url
|
|
- valid
|
|
WritableVirtualChassis:
|
|
type: object
|
|
description: Extends ModelSerializer to render any CustomFields and their values
|
|
associated with an object.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
domain:
|
|
type: string
|
|
maxLength: 30
|
|
master:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
member_count:
|
|
type: integer
|
|
readOnly: true
|
|
computed_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- computed_fields
|
|
- display
|
|
- id
|
|
- member_count
|
|
- name
|
|
- url
|
|
WritableVirtualMachineWithConfigContext:
|
|
type: object
|
|
description: Mixin to add `status` choice field to model serializers.
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
url:
|
|
type: string
|
|
format: uri
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
maxLength: 64
|
|
status:
|
|
$ref: '#/components/schemas/WritableVirtualMachineWithConfigContextStatusEnum'
|
|
site:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedSite'
|
|
readOnly: true
|
|
cluster:
|
|
type: string
|
|
format: uuid
|
|
role:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
tenant:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
platform:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
primary_ip:
|
|
allOf:
|
|
- $ref: '#/components/schemas/NestedIPAddress'
|
|
readOnly: true
|
|
primary_ip4:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv4
|
|
primary_ip6:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
title: Primary IPv6
|
|
vcpus:
|
|
type: integer
|
|
maximum: 32767
|
|
minimum: 0
|
|
nullable: true
|
|
memory:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Memory (MB)
|
|
disk:
|
|
type: integer
|
|
maximum: 2147483647
|
|
minimum: 0
|
|
nullable: true
|
|
title: Disk (GB)
|
|
comments:
|
|
type: string
|
|
local_context_data:
|
|
type: object
|
|
additionalProperties: {}
|
|
nullable: true
|
|
local_context_schema:
|
|
type: string
|
|
format: uuid
|
|
nullable: true
|
|
description: Optional schema to validate the structure of the data
|
|
tags:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TagSerializerField'
|
|
custom_fields:
|
|
type: object
|
|
additionalProperties: {}
|
|
config_context:
|
|
type: object
|
|
additionalProperties: {}
|
|
readOnly: true
|
|
created:
|
|
type: string
|
|
format: date
|
|
readOnly: true
|
|
last_updated:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
display:
|
|
type: string
|
|
readOnly: true
|
|
description: Human friendly display value
|
|
required:
|
|
- cluster
|
|
- config_context
|
|
- created
|
|
- display
|
|
- id
|
|
- last_updated
|
|
- name
|
|
- primary_ip
|
|
- site
|
|
- status
|
|
- url
|
|
WritableVirtualMachineWithConfigContextStatusEnum:
|
|
type: string
|
|
enum:
|
|
- active
|
|
- decommissioning
|
|
- failed
|
|
- offline
|
|
- planned
|
|
- staged
|
|
securitySchemes:
|
|
basicAuth:
|
|
type: http
|
|
scheme: basic
|
|
cookieAuth:
|
|
type: apiKey
|
|
in: cookie
|
|
name: sessionid
|
|
tokenAuth:
|
|
type: apiKey
|
|
in: header
|
|
name: Authorization
|
|
description: Token-based authentication with required prefix "Token"
|
|
servers:
|
|
- url: /api
|